WebGLRenderingContext: scissor() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
The WebGLRenderingContext.scissor() method of the WebGL API sets a scissor box, which limits
the drawing to a specified rectangle.
Syntax
scissor(x, y, width, height)
Parameters
x-
A
GLintspecifying the horizontal coordinate for the lower left corner of the box. Default value: 0. y-
A
GLintspecifying the vertical coordinate for the lower left corner of the box. Default value: 0. width-
A non-negative
GLsizeispecifying the width of the scissor box. Default value: width of the canvas. height-
A non-negative
GLsizeispecifying the height of the scissor box. Default value: height of the canvas.
Return value
None (undefined).
Exceptions
If either width or height is a negative value, a
gl.INVALID_VALUE error is thrown.
Examples
When the scissor test is enabled, only pixels within the scissor box can be modified by drawing commands.
// turn on scissor test
gl.enable(gl.SCISSOR_TEST);
// set the scissor rectangle
gl.scissor(x, y, width, height);
// execute drawing commands in the scissor box (e.g. clear)
// turn off scissor test again
gl.disable(gl.SCISSOR_TEST);
To get the current scissor box dimensions, query the SCISSOR_BOX constant
which returns an Int32Array.
gl.scissor(0, 0, 200, 200);
gl.getParameter(gl.SCISSOR_BOX);
// Int32Array[0, 0, 200, 200]
Specifications
| Specification |
|---|
| WebGL Specification # 5.14.4 |
Browser compatibility
BCD tables only load in the browser