Your Search Results

    WebGL2RenderingContext.getBufferSubData()

    This is an experimental technology
    Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

    The WebGL2RenderingContext.getBufferSubData() method of the WebGL 2 API reads data from a buffer binding point and writes them to an ArrayBuffer or SharedArrayBuffer.

    Syntax

    void gl.getBufferSubData(target, offset, returnedData);

    Parameters

    target
    A GLenum specifying the binding point (target). 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.
    • 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.
    offset
    A GLintptr specifying the byte offset from which to start reading from the buffer.
    returnedData
    A ArrayBuffer or SharedArrayBuffer to which to write the buffer data.

    Return value

    None.

    Exceptions

    An INVALID_VALUE error is generated if:

    • offset + returnedData.byteLength would extend beyond the end of the buffer
    • returnedData is null
    • offset is less than zero.

    An INVALID_OPERATION error is generated if:

    • zero is bound to target
    • target is TRANSFORM_FEEDBACK_BUFFER, and any transform feedback object is currently active.

    Examples

    var buffer = gl.createBuffer();
gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
gl.bufferData(gl.ARRAY_BUFFER, new Float32Array(vertices), gl.STATIC_DRAW);

var arrBuffer = new ArrayBuffer(vertices.length * Float32Array.BYTES_PER_ELEMENT);
gl.getBufferSubData(gl.ARRAY_BUFFER, 0, arrBuffer);

    Specifications

    Specification Status Comment
    WebGL 2.0
    The definition of 'getBufferSubData' in that specification.    		 Editor's Draft Initial definition.

    Browser compatibility

    Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
    Basic support No support [2] Nightly build [1] No support No support No support
    Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
    Basic support No support No support No support No support No support No support

    [1] WebGL 2 is enabled by default in Firefox Nightly. To enable it in a release version of Firefox, set the preference webgl.enable-prototype-webgl2 to true in about:config.

    [2] To use an experimental implementation of WebGL 2 in Chrome, you have to start Chrome with the runtime flag --enable-unsafe-es3-apis.

    See also

    Document Tags and Contributors

    Tags: 
     Contributors to this page: fscholz
     Last updated by: fscholz,