glGetBufferPointerv

From OpenGL Reference
Jump to navigation Jump to search

Return the pointer to a mapped buffer object's data store.

C Specification[edit]

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


Parameters[edit]

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 - 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[edit]

 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[edit]

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[edit]

 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[edit]

 glGetBufferPointerv  2.0+
 glGetNamedBufferPointerv  4.5+

See Also[edit]

 glBindBuffer , glMapBuffer 


Copyright[edit]

Copyright© 2005 Addison-Wesley. Copyright© 2011-2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.