The WebGLRenderingContext.getBufferParameter()
method of the WebGL API returns information about the buffer.
Syntax
any gl.getBufferParameter(target, pname);
Parameters
- target
- A
Glenum
specifying the target buffer object. Possible values:gl.ARRAY_BUFFER
: Buffer containing vertex attributes, such as vertex coordinates, texture coordinate data, or vertex color data.gl.ELEMENT_ARRAY_BUFFER
: Buffer used for element indices.- When using a WebGL 2 context, the following values are available additionally:
gl.COPY_READ_BUFFER
: Buffer for copying from one buffer object to another.gl.COPY_WRITE_BUFFER
: Buffer for copying from one buffer object to another.gl.TRANSFORM_FEEDBACK_BUFFER
: Buffer for transform feedback operations.gl.UNIFORM_BUFFER
: Buffer used for storing uniform blocks.gl.PIXEL_PACK_BUFFER
: Buffer used for pixel transfer operations.gl.PIXEL_UNPACK_BUFFER
: Buffer used for pixel transfer operations.
- pname
- A
Glenum
specifying information to query. Possible values:gl.BUFFER_SIZE
: Returns aGLint
indicating the size of the buffer in bytes.gl.BUFFER_USAGE
: Returns aGLenum
indicating the usage pattern of the buffer. This is either:gl.STATIC_DRAW
,gl.DYNAMIC_DRAW
,gl.STREAM_DRAW
.- When using a WebGL 2 context, the following values are available additionally:
gl.STATIC_READ
,gl.DYNAMIC_READ,
gl.STREAM_READ
,gl.STATIC_COPY
,gl.DYNAMIC_COPY,
gl.STREAM_COPY
.
Return value
Depends on the requested information (as specified with pname
). Either a GLint
or a GLenum
.
Examples
gl.getBufferParameter(gl.ARRAY_BUFFER, gl.BUFFER_SIZE);
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'getBufferParameter' in that specification. |
Recommendation | Initial definition for WebGL. |
OpenGL ES 2.0 The definition of 'glGetBufferParameteriv' in that specification. |
Standard | Man page of the (similar) OpenGL ES 2 API. |
WebGL 2.0 The definition of 'getBufferParameter' in that specification. |
Editor's Draft | Updated definition for WebGL. |
OpenGL ES 3.0 The definition of 'glGetBufferParameter' in that specification. |
Standard | Man page of the (similar) OpenGL ES 3 API. Adds new target buffers:gl.COPY_READ_BUFFER ,gl.COPY_WRITE_BUFFER ,gl.TRANSFORM_FEEDBACK_BUFFER ,gl.UNIFORM_BUFFER ,gl.PIXEL_PACK_BUFFER ,gl.PIXEL_UNPACK_BUFFER Adds new usage hints:gl.STATIC_READ ,gl.DYNAMIC_READ ,gl.STREAM_READ ,gl.STATIC_COPY ,gl.DYNAMIC_COPY ,gl.STREAM_COPY . |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getBufferParameter | Chrome Full support 9 | Edge Full support 12 | Firefox Full support 4 | IE Full support 11 | Opera Full support 12 | Safari Full support 5.1 | WebView Android Full support Yes | Chrome Android Full support 25 | Firefox Android Full support Yes | Opera Android Full support 12 | Safari iOS Full support 8 | Samsung Internet Android Full support 1.5 |
WebGL2 | Chrome Full support 56 | Edge Full support 79 | Firefox Full support 51 | IE No support No | Opera Full support 43 | Safari No support No | WebView Android Full support 58 | Chrome Android Full support 58 | Firefox Android Full support 51 | Opera Android Full support 43 | Safari iOS No support No | Samsung Internet Android Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support