GLAPI/glScissorIndexed: Difference between revisions
m Bot: Adding better formatting. |
m Bot: Adding better formatting. |
||
(One intermediate revision by the same user not shown) | |||
Line 23: | Line 23: | ||
== Description == | == Description == | ||
'''glScissorIndexed''' defines the scissor box for a specified viewport. {{param|index}} specifies the index of scissor box to modify. {{param|index}} must be less than the value of {{ | '''glScissorIndexed''' defines the scissor box for a specified viewport. {{param|index}} specifies the index of scissor box to modify. {{param|index}} must be less than the value of {{enum|GL_MAX_VIEWPORTS}}. For '''glScissorIndexed''', {{param|left}}, {{param|bottom}}, {{param|width}} and {{param|height}} specify the left, bottom, width and height of the scissor box, in pixels, respectively. For '''glScissorIndexedv''', {{param|v}} specifies the address of an array containing integers specifying the lower left corner of the scissor box, and the width and height of the scissor box, in that order. | ||
To enable and disable the scissor test, call {{apifunc|glEnable}} and {{apifunc|glDisable}} with argument {{ | To enable and disable the scissor test, call {{apifunc|glEnable}} and {{apifunc|glDisable}} with argument {{enum|GL_SCISSOR_TEST}}. The test is initially disabled for all viewports. While the test is enabled, only pixels that lie within the scissor box can be modified by drawing commands. Window coordinates have integer values at the shared corners of frame buffer pixels. {{code|glScissor(0,0,1,1)}} allows modification of only the lower left pixel in the window, and {{code|glScissor(0,0,0,0)}} doesn't allow modification of any pixels in the window. | ||
When the scissor test is disabled, it is as though the scissor box includes the entire window. | When the scissor test is disabled, it is as though the scissor box includes the entire window. | ||
Line 31: | Line 31: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|index}} is greater than or equal to the value of {{enum|GL_MAX_VIEWPORTS}}. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if any width or height specified in the array {{param|v}} is negative. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGet}} with argument {{ | {{apifunc|glGet}} with argument {{enum|GL_SCISSOR_BOX}} | ||
{{apifunc|glIsEnabled}} with argument {{ | {{apifunc|glIsEnabled}} with argument {{enum|GL_SCISSOR_TEST}} | ||
== See Also == | == See Also == | ||
{{apifunc|glEnable}}, {{apifunc|glScissor}}, {{apifunc|glScissorArray}} | {{apifunc|glEnable|(GL_SCISSOR_TEST)}}, {{apifunc|glScissor}}, {{apifunc|glScissorArray}}, {{apifunc|glViewportIndexed}} | ||
== Copyright == | == Copyright == |
Latest revision as of 01:54, 27 September 2012
Core in version | 4.6 | |
---|---|---|
Core since version | 4.1 | |
Core ARB extension | ARB_viewport_array |
glScissorIndexed: define the scissor box for a specific viewport
Function Definition
void glScissorIndexed(GLuint index, GLint left, GLint bottom, GLsizei width, GLsizei height); void glScissorIndexedv(GLuint index, const GLint *v);
- index
- Specifies the index of the viewport whose scissor box to modify.
- left, bottom
- Specify the coordinate of the bottom left corner of the scissor box, in pixels.
- width, height
- Specify ths dimensions of the scissor box, in pixels.
- v
- For glScissorIndexedv, specifies the address of an array containing the left, bottom, width and height of each scissor box, in that order.
Description
glScissorIndexed defines the scissor box for a specified viewport. index specifies the index of scissor box to modify. index must be less than the value of GL_MAX_VIEWPORTS. For glScissorIndexed, left, bottom, width and height specify the left, bottom, width and height of the scissor box, in pixels, respectively. For glScissorIndexedv, v specifies the address of an array containing integers specifying the lower left corner of the scissor box, and the width and height of the scissor box, in that order.
To enable and disable the scissor test, call glEnable and glDisable with argument GL_SCISSOR_TEST. The test is initially disabled for all viewports. While the test is enabled, only pixels that lie within the scissor box can be modified by drawing commands. Window coordinates have integer values at the shared corners of frame buffer pixels. glScissor(0,0,1,1) allows modification of only the lower left pixel in the window, and glScissor(0,0,0,0) doesn't allow modification of any pixels in the window.
When the scissor test is disabled, it is as though the scissor box includes the entire window.
Errors
GL_INVALID_VALUE is generated if index is greater than or equal to the value of GL_MAX_VIEWPORTS.
GL_INVALID_VALUE is generated if any width or height specified in the array v is negative.
Associated Gets
glGet with argument GL_SCISSOR_BOX
glIsEnabled with argument GL_SCISSOR_TEST
See Also
glEnable(GL_SCISSOR_TEST), glScissor, glScissorArray, glViewportIndexed
Copyright
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.