WebGL2RenderingContext: drawElementsInstanced() method
WebGL
WebGL
The WebGL2RenderingContext.drawElementsInstanced() method
of the WebGL 2 API renders primitives from
array data like the gl.drawElements() method. In addition, it can execute multiple instances of a set
of elements.
[!NOTE] When using WebGL 1, the ANGLE_instanced_arrays extension can provide this method, too.
Syntax
drawElementsInstanced(mode, count, type, offset, instanceCount)
Parameters
mode-
: A GLenum specifying the type primitive to render. Possible values are:
gl.POINTS: Draws a single dot.gl.LINE_STRIP: Draws a straight line to the next vertex.gl.LINE_LOOP: Draws a straight line to the next vertex, and connects the last vertex back to the first.gl.LINES: Draws a line between a pair of vertices.gl.TRIANGLE_STRIPgl.TRIANGLE_FANgl.TRIANGLES: Draws a triangle for a group of three vertices.
-
count - : A GLsizei specifying the number of elements to be rendered.
type-
: A GLenum specifying the type of the values in the element array buffer. Possible values are:
gl.UNSIGNED_BYTEgl.UNSIGNED_SHORTgl.UNSIGNED_INTWhen using the OES_element_index_uint extension.
-
offset - : A GLintptr specifying an offset in the element array buffer. Must be
a valid multiple of the size of the given
type. instanceCount- : A GLsizei specifying the number of instances of the set of elements to execute.
Return value
None (undefined).
Exceptions
- If
modeis not one of the accepted values, agl.INVALID_ENUMerror is thrown. - If
offsetis a valid multiple of the size of the given type, agl.INVALID_OPERATIONerror is thrown. - If
countorinstanceCountare negative, agl.INVALID_VALUEerror is thrown.
Examples
gl.drawElementsInstanced(gl.POINTS, 2, gl.UNSIGNED_SHORT, 0, 4);
Specifications
Browser compatibility
See also
- ext.drawArraysInstancedANGLE()
- ext.vertexAttribDivisorANGLE()
- WebGLRenderingContext.drawArrays()
- WebGLRenderingContext.drawElements()
- WebGL2RenderingContext.drawArraysInstanced()
- WebGL2RenderingContext.vertexAttribDivisor()
- WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()