Your Search Results

    WebGLRenderingContext.getBufferParameter()

    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 a GLint indicating the size of the buffer in bytes.
    • gl.BUFFER_USAGE: Returns a GLenum 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

    Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
    Basic support 9 12 4.0 (2.0) 11 12 5.1
    WebGL 2 No support [2] No support Nightly build [1] No support No support No support
    Feature Android Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
    Basic support ? 25 4.0 (2.0) 1.0 ? 12 8.0
    WebGL 2 No 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,