GLAPI/glGetBufferParameter: Difference between revisions
< GLAPI
m Bot: Adding better formatting. |
m Bot: Adding better formatting. |
||
| Line 11: | Line 11: | ||
; target | ; target | ||
: Specifies the target buffer object. The symbolic constant must be {{ | : Specifies the target buffer object. The symbolic constant must be {{enum|GL_ARRAY_BUFFER}}, {{enum|GL_COPY_READ_BUFFER}}, {{enum|GL_COPY_WRITE_BUFFER}}, {{enum|GL_ELEMENT_ARRAY_BUFFER}}, {{enum|GL_PIXEL_PACK_BUFFER}}, {{enum|GL_PIXEL_UNPACK_BUFFER}}, {{enum|GL_TEXTURE_BUFFER}}, {{enum|GL_TRANSFORM_FEEDBACK_BUFFER}}, or {{enum|GL_UNIFORM_BUFFER}}. | ||
; value | ; value | ||
: Specifies the symbolic name of a buffer object parameter. Accepted values are {{ | : Specifies the symbolic name of a buffer object parameter. Accepted values are {{enum|GL_BUFFER_ACCESS}}, {{enum|GL_BUFFER_MAPPED}}, {{enum|GL_BUFFER_SIZE}}, or {{enum|GL_BUFFER_USAGE}}. | ||
; data | ; data | ||
: Returns the requested parameter. | : Returns the requested parameter. | ||
| Line 23: | Line 23: | ||
{{param|value}} names a specific buffer object parameter, as follows: | {{param|value}} names a specific buffer object parameter, as follows: | ||
; {{ | ; {{enum|GL_BUFFER_ACCESS}} | ||
: {{param|params}} returns the access policy set while mapping the buffer object. The initial value is {{ | : {{param|params}} returns the access policy set while mapping the buffer object. The initial value is {{enum|GL_READ_WRITE}}. | ||
; {{ | ; {{enum|GL_BUFFER_MAPPED}} | ||
: {{param|params}} returns a flag indicating whether the buffer object is currently mapped. The initial value is {{ | : {{param|params}} returns a flag indicating whether the buffer object is currently mapped. The initial value is {{enum|GL_FALSE}}. | ||
; {{ | ; {{enum|GL_BUFFER_SIZE}} | ||
: {{param|params}} returns the size of the buffer object, measured in bytes. The initial value is 0. | : {{param|params}} returns the size of the buffer object, measured in bytes. The initial value is 0. | ||
; {{ | ; {{enum|GL_BUFFER_USAGE}} | ||
: {{param|params}} returns the buffer object's usage pattern. The initial value is {{ | : {{param|params}} returns the buffer object's usage pattern. The initial value is {{enum|GL_STATIC_DRAW}}. | ||
== Notes == | == Notes == | ||
| Line 37: | Line 37: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|value}} is not an accepted value. | ||
{{ | {{enum|GL_INVALID_OPERATION}} is generated if the reserved buffer object name 0 is bound to {{param|target}}. | ||
== See Also == | == See Also == | ||
Revision as of 17:23, 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/.