glScissorIndexed - define the scissor box for a specific viewport
Contents
Associated Gets
glGet() with argument GL_SCISSOR_BOXglIsEnabled() with argument GL_SCISSOR_TEST
C Specification
voidglScissorIndexed(GLuintindex,GLintleft,GLintbottom,GLsizeiwidth,GLsizeiheight);voidglScissorIndexedv(GLuintindex,constGLint*v);
Copyright
Copyright © 2010-2014 Khronos Group
[FIXME: source] 11/18/2024 GLSCISSORINDEXED(3G)
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.
Name
glScissorIndexed - define the scissor box for a specific viewport
Parameters
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.
See Also
glEnable(), glScissor(), glScissorArray()
Version Support
┌───────────────────┬───────────────────────────────────────────────────────────────────────┐
│ │ OpenGLVersion │
├───────────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
│ Function │ 2.0 │ 2.1 │ 3.0 │ 3.1 │ 3.2 │ 3.3 │ 4.0 │ 4.1 │ 4.2 │ 4.3 │ 4.4 │ 4.5 │
│ / │ │ │ │ │ │ │ │ │ │ │ │ │
│ Feature │ │ │ │ │ │ │ │ │ │ │ │ │
│ Name │ │ │ │ │ │ │ │ │ │ │ │ │
├───────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ glScissorIndexed │ - │ - │ - │ - │ - │ - │ - │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
├───────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ glScissorIndexedv │ - │ - │ - │ - │ - │ - │ - │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
└───────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
