GLAPI/glGetBufferPointer: Difference between revisions
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glGetBufferPointerv'''(GLenum | void '''glGetBufferPointerv'''(GLenum {{param|target}}, GLenum {{param|pname}}, GLvoid ** {{param|params}}); | ||
; target | ; target | ||
| Line 15: | Line 15: | ||
: Specifies the pointer to be returned. The symbolic constant must be {{code|GL_BUFFER_MAP_POINTER}}. | : Specifies the pointer to be returned. The symbolic constant must be {{code|GL_BUFFER_MAP_POINTER}}. | ||
; params | ; params | ||
: Returns the pointer value specified by | : Returns the pointer value specified by {{param|pname}}. | ||
== Description == | == Description == | ||
'''glGetBufferPointerv''' returns pointer information. | '''glGetBufferPointerv''' returns pointer information. {{param|pname}} is a symbolic constant indicating the pointer to be returned, which must be {{code|GL_BUFFER_MAP_POINTER}}, the pointer to which the buffer object's data store is mapped. If the data store is not currently mapped, {{code|NULL}} is returned. {{param|params}} is a pointer to a location in which to place the returned pointer value. | ||
== Notes == | == Notes == | ||
If an error is generated, no change is made to the contents of | If an error is generated, no change is made to the contents of {{param|params}}. | ||
The initial value for the pointer is {{code|NULL}}. | The initial value for the pointer is {{code|NULL}}. | ||
| Line 29: | Line 29: | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|pname}} is not an accepted value. | ||
{{code|GL_INVALID_OPERATION}} is generated if the reserved buffer object name 0 is bound to | {{code|GL_INVALID_OPERATION}} is generated if the reserved buffer object name 0 is bound to {{param|target}}. | ||
== See Also == | == See Also == | ||
{{apifunc|glBindBuffer}}, {{apifunc|glMapBuffer}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:19, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.5 | |
glGetBufferPointerv: return the pointer to a mapped buffer object's data store
Function Definition
void glGetBufferPointerv(GLenum target, GLenum pname, GLvoid ** params);
- target
- Specifies the target buffer object. The symbolic constant must be GL_ARRAY_BUFFER, GL_COPY_READ_BUFFER, GL_COPY_WRITE_BUFFER, GL_ELEMENT_ARRAY_BUFFER, GL_PIXEL_PACK_BUFFER, GL_PIXEL_UNPACK_BUFFER, GL_TEXTURE_BUFFER, GL_TRANSFORM_FEEDBACK_BUFFER, or GL_UNIFORM_BUFFER.
- pname
- Specifies the pointer to be returned. The symbolic constant must be GL_BUFFER_MAP_POINTER.
- params
- Returns the pointer value specified by pname.
Description
glGetBufferPointerv returns pointer information. pname is a symbolic constant indicating the pointer to be returned, which must be GL_BUFFER_MAP_POINTER, the pointer to which the buffer object's data store is mapped. If the data store is not currently mapped, NULL is returned. params is a pointer to a location in which to place the returned pointer value.
Notes
If an error is generated, no change is made to the contents of params.
The initial value for the pointer is NULL.
Errors
GL_INVALID_ENUM is generated if target or pname is not an accepted value.
GL_INVALID_OPERATION is generated if the reserved buffer object name 0 is bound to target.
See Also
Copyright
Copyright © 2005 Addison-Wesley. 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/.