WebGLRenderingContext: drawElements() 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.
Note: This feature is available in Web Workers.
The WebGLRenderingContext.drawElements() method of the WebGL API renders primitives from array data.
Syntax
drawElements(mode, count, type, offset)
Parameters
mode-
A
GLenumspecifying 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
GLsizeispecifying the number of elements of the bound element array buffer to be rendered. For example, to draw a wireframe triangle withgl.LINESthe count should be 2 endpoints per line × 3 lines = 6 elements. However to draw the same wireframe triangle withgl.LINE_STRIPthe element array buffer does not repeat the indices for the end of the first line/start of the second line, and end of the second line/start of the third line, socountwill be four. To draw the same triangle withgl.LINE_LOOPthe element array buffer does not repeat the first/last vertex either socountwill be three. type-
A
GLenumspecifying the type of the values in the element array buffer. Possible values are:gl.UNSIGNED_BYTEgl.UNSIGNED_SHORT
When using the
OES_element_index_uintextension:gl.UNSIGNED_INT
offset-
A
GLintptrspecifying a byte offset in the element array buffer. Must be a valid multiple of the size of the giventype.
Return value
None (undefined).
Exceptions
- If
modeis not one of the accepted values, agl.INVALID_ENUMerror is thrown. - If
offsetis not a valid multiple of the size of the given type, agl.INVALID_OPERATIONerror is thrown. - If
countis negative, agl.INVALID_VALUEerror is thrown.
Examples
gl.drawElements(gl.POINTS, 8, gl.UNSIGNED_BYTE, 0);
Specifications
| Specification |
|---|
| WebGL Specification> # 5.14.11> |
Browser compatibility
Loading…