glGetBufferPointerv.3G - Man Page

return the pointer to a mapped buffer object's data store

C Specification

void glGetBufferPointerv(GLenum target, GLenum pname, GLvoid ** params);

void glGetNamedBufferPointerv(GLuint buffer, GLenum pname, void **params);

Parameters

target

Specifies the target to which the buffer object is bound for glGetBufferPointerv, 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 glGetNamedBufferPointerv.

pname

Specifies the name of the pointer to be returned. Must be GL_BUFFER_MAP_POINTER.

params

Returns the pointer value specified by pname.

Description

glGetBufferPointerv and glGetNamedBufferPointerv return the buffer pointer pname, which must be GL_BUFFER_MAP_POINTER. The single buffer map pointer is returned in params. A NULL pointer is returned if the buffer object's data store is not currently mapped; or if the requesting context did not map the buffer object's data store, and the implementation is unable to support mappings on multiple clients.

Notes

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

The initial value for the pointer is NULL.

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 if by glGetBufferPointerv if target is not one of the accepted buffer targets, or if pname is not GL_BUFFER_MAP_POINTER.

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

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

Version Support

OpenGL Version
Function / Feature Name2.02.13.03.13.23.34.04.14.24.34.44.5
glGetBufferPointerv
glGetNamedBufferPointerv-----------

See Also

glBindBuffer(), glMapBuffer()

Referenced By

glGet.3G(3), glGetBufferParameteriv.3G(3).

The man page glGetNamedBufferPointerv.3G(3) is an alias of glGetBufferPointerv.3G(3).

01/24/2024