WebGL2RenderingContext: bufferSubData() method
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.
* Some parts of this feature may have varying levels of support.
Note: This feature is available inWeb Workers.
TheWebGL2RenderingContext.bufferSubData() method of theWebGL API updates a subset of a bufferobject's data store.
In this article
Syntax
bufferSubData(target, dstByteOffset, srcData)bufferSubData(target, dstByteOffset, srcData, srcOffset)bufferSubData(target, dstByteOffset, srcData, srcOffset, length)Parameters
targetA
GLenumspecifying the binding point (target). Possible values:gl.ARRAY_BUFFERBuffer containing vertex attributes, such asvertex coordinates, texture coordinate data, or vertex color data.
gl.ELEMENT_ARRAY_BUFFERBuffer used for element indices.
gl.COPY_READ_BUFFERBuffer for copying from one buffer object to another.
gl.COPY_WRITE_BUFFERBuffer for copying from one buffer object to another.
gl.TRANSFORM_FEEDBACK_BUFFERBuffer for transform feedback operations.
gl.UNIFORM_BUFFERBuffer used for storing uniform blocks.
gl.PIXEL_PACK_BUFFERBuffer used for pixel transfer operations.
gl.PIXEL_UNPACK_BUFFERBuffer used for pixel transfer operations.
dstByteOffsetA
GLintptrspecifying an offset in bytes where the data replacementwill start.srcDataOptionalA
TypedArrayor aDataViewthat views anArrayBufferorSharedArrayBufferthat will be copied into the data store.srcOffsetOptionalA
GLuintspecifying the element index offset where to start readingthe buffer.lengthOptionalA
GLuintdefaulting to 0, where 0 meansbufferSubDatashould calculate the length.
Return value
None (undefined).
Exceptions
- A
gl.INVALID_VALUEerror is thrown if the data would be written pastthe end of the buffer or ifdataisnull. - A
gl.INVALID_ENUMerror is thrown iftargetis not one ofthe allowed enums.
Specifications
| Specification |
|---|
| WebGL Specification> # 5.14.5> |