glGetBufferSubData.3G man page

glGetBufferSubData, glGetNamedBufferSubData — returns a subset of a buffer object's data store

C Specification

void glGetBufferSubData(GLenum target, GLintptr offset, GLsizeiptr size, GLvoid * data);

void glGetNamedBufferSubData(GLuint buffer, GLintptr offset, GLsizei size, void *data);

Parameters

target

Specifies the target to which the buffer object is bound for glGetBufferSubData, which must be one of the buffer binding targets in the following table:

Buffer Binding TargetPurpose
GL_ARRAY_BUFFERVertex attributes
GL_ATOMIC_COUNTER_BUFFERAtomic counter storage
GL_COPY_READ_BUFFERBuffer copy source
GL_COPY_WRITE_BUFFERBuffer copy destination
GL_DISPATCH_INDIRECT_BUFFERIndirect compute dispatch commands
GL_DRAW_INDIRECT_BUFFERIndirect command arguments
GL_ELEMENT_ARRAY_BUFFERVertex array indices
GL_PIXEL_PACK_BUFFERPixel read target
GL_PIXEL_UNPACK_BUFFERTexture data source
GL_QUERY_BUFFERQuery result buffer
GL_SHADER_STORAGE_BUFFERRead-write storage for shaders
GL_TEXTURE_BUFFERTexture data buffer
GL_TRANSFORM_FEEDBACK_BUFFERTransform feedback buffer
GL_UNIFORM_BUFFERUniform block storage

buffer

Specifies the name of the buffer object for glGetNamedBufferSubData.

offset

Specifies the offset into the buffer object's data store from which data will be returned, measured in bytes.

size

Specifies the size in bytes of the data store region being returned.

data

Specifies a pointer to the location where buffer object data is returned.

Description

glGetBufferSubData and glGetNamedBufferSubData return some or all of the data contents of the data store of the specified buffer object. Data starting at byte offset offset and extending for size bytes is copied from the buffer object's data store to the memory pointed to by data. An error is thrown if the buffer object is currently mapped, or if offset and size together define a range beyond the bounds of the buffer object's data store.

Notes

If an error is generated, no change is made to the contents of data.

The GL_ATOMIC_COUNTER_BUFFER target is available only if the GL version is 4.2 or greater.

The GL_DISPATCH_INDIRECT_BUFFER and GL_SHADER_STORAGE_BUFFER targets are available only if the GL version is 4.3 or greater.

The GL_QUERY_BUFFER target is available only if the GL version is 4.4 or greater.

Errors

GL_INVALID_ENUM is generated by glGetBufferSubData if target is not one of the generic buffer binding targets.

GL_INVALID_OPERATION is generated by glGetBufferSubData if zero is bound to target.

GL_INVALID_OPERATION is generated by glGetNamedBufferSubData if buffer is not the name of an existing buffer object.

GL_INVALID_VALUE is generated if offset or size is negative, or if $offset + size$ is greater than the value of GL_BUFFER_SIZE for the buffer object.

GL_INVALID_OPERATION is generated if the buffer object is mapped with glMapBufferRange() or glMapBuffer(), unless it was mapped with the GL_MAP_PERSISTENT_BIT bit set in the glMapBufferRange access flags.

Version Support

OpenGL Version
Function / Feature Name2.02.13.03.13.23.34.04.14.24.34.44.5
glGetBufferSubData
glGetNamedBufferSubData-----------

See Also

glBindBuffer(), glBufferData(), glBufferSubData(), glMapBuffer(), glUnmapBuffer()

Referenced By

glGetNamedBufferSubData.3G(3) is an alias of glGetBufferSubData.3G(3).

12/28/2016 [FIXME: source] [FIXME: manual]