GLAPI/glGetBufferParameter: Difference between revisions
< GLAPI
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glGetBufferParameteriv'''(GLenum | void '''glGetBufferParameteriv'''(GLenum {{param|target}}, GLenum {{param|value}}, GLint * {{param|data}}); | ||
; target | ; target | ||
| Line 19: | Line 19: | ||
== Description == | == Description == | ||
'''glGetBufferParameteriv''' returns in | '''glGetBufferParameteriv''' returns in {{param|data}} a selected parameter of the buffer object specified by {{param|target}}. | ||
{{param|value}} names a specific buffer object parameter, as follows: | |||
; {{code|GL_BUFFER_ACCESS}} | ; {{code|GL_BUFFER_ACCESS}} | ||
: | : {{param|params}} returns the access policy set while mapping the buffer object. The initial value is {{code|GL_READ_WRITE}}. | ||
; {{code|GL_BUFFER_MAPPED}} | ; {{code|GL_BUFFER_MAPPED}} | ||
: | : {{param|params}} returns a flag indicating whether the buffer object is currently mapped. The initial value is {{code|GL_FALSE}}. | ||
; {{code|GL_BUFFER_SIZE}} | ; {{code|GL_BUFFER_SIZE}} | ||
: | : {{param|params}} returns the size of the buffer object, measured in bytes. The initial value is 0. | ||
; {{code|GL_BUFFER_USAGE}} | ; {{code|GL_BUFFER_USAGE}} | ||
: | : {{param|params}} returns the buffer object's usage pattern. The initial value is {{code|GL_STATIC_DRAW}}. | ||
== 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|data}}. | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|value}} 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|glBufferData}}, {{apifunc|glMapBuffer}}, {{apifunc|glUnmapBuffer}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:19, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.5 | |
glGetBufferParameteriv: return parameters of a buffer object
Function Definition
void glGetBufferParameteriv(GLenum target, GLenum value, GLint * data);
- 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.
- value
- Specifies the symbolic name of a buffer object parameter. Accepted values are GL_BUFFER_ACCESS, GL_BUFFER_MAPPED, GL_BUFFER_SIZE, or GL_BUFFER_USAGE.
- data
- Returns the requested parameter.
Description
glGetBufferParameteriv returns in data a selected parameter of the buffer object specified by target.
value names a specific buffer object parameter, as follows:
- GL_BUFFER_ACCESS
- params returns the access policy set while mapping the buffer object. The initial value is GL_READ_WRITE.
- GL_BUFFER_MAPPED
- params returns a flag indicating whether the buffer object is currently mapped. The initial value is GL_FALSE.
- GL_BUFFER_SIZE
- params returns the size of the buffer object, measured in bytes. The initial value is 0.
- GL_BUFFER_USAGE
- params returns the buffer object's usage pattern. The initial value is GL_STATIC_DRAW.
Notes
If an error is generated, no change is made to the contents of data.
Errors
GL_INVALID_ENUM is generated if target or value is not an accepted value.
GL_INVALID_OPERATION is generated if the reserved buffer object name 0 is bound to target.
See Also
glBindBuffer, glBufferData, glMapBuffer, glUnmapBuffer
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/.