GLAPI/glGetRenderbufferParameter: 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 '''glGetRenderbufferParameteriv'''(GLenum | void '''glGetRenderbufferParameteriv'''(GLenum {{param|target}}, GLenum {{param|pname}}, GLint *{{param|params}}); | ||
; target | ; target | ||
: Specifies the target of the query operation. | : Specifies the target of the query operation. {{param|target}} must be {{code|GL_RENDERBUFFER}}. | ||
; pname | ; pname | ||
: Specifies the parameter whose value to retrieve from the renderbuffer bound to | : Specifies the parameter whose value to retrieve from the renderbuffer bound to {{param|target}}. | ||
; params | ; params | ||
: Specifies the address of an array to receive the value of the queried parameter. | : Specifies the address of an array to receive the value of the queried parameter. | ||
| Line 19: | Line 19: | ||
== Description == | == Description == | ||
'''glGetRenderbufferParameteriv''' retrieves information about a bound renderbuffer object. | '''glGetRenderbufferParameteriv''' retrieves information about a bound renderbuffer object. {{param|target}} specifies the target of the query operation and must be {{code|GL_RENDERBUFFER}}. {{param|pname}} specifies the parameter whose value to query and must be one of {{code|GL_RENDERBUFFER_WIDTH}}, {{code|GL_RENDERBUFFER_HEIGHT}}, {{code|GL_RENDERBUFFER_INTERNAL_FORMAT}}, {{code|GL_RENDERBUFFER_RED_SIZE}}, {{code|GL_RENDERBUFFER_GREEN_SIZE}}, {{code|GL_RENDERBUFFER_BLUE_SIZE}}, {{code|GL_RENDERBUFFER_ALPHA_SIZE}}, {{code|GL_RENDERBUFFER_DEPTH_SIZE}}, {{code|GL_RENDERBUFFER_DEPTH_SIZE}}, {{code|GL_RENDERBUFFER_STENCIL_SIZE}}, or {{code|GL_RENDERBUFFER_SAMPLES}}. | ||
Upon a successful return from '''glGetRenderbufferParameteriv''', if | Upon a successful return from '''glGetRenderbufferParameteriv''', if {{param|pname}} is {{code|GL_RENDERBUFFER_WIDTH}}, {{code|GL_RENDERBUFFER_HEIGHT}}, {{code|GL_RENDERBUFFER_INTERNAL_FORMAT}}, or {{code|GL_RENDERBUFFER_SAMPLES}}, then {{param|params}} will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively, of the image of the renderbuffer currently bound to {{param|target}}. | ||
If | If {{param|pname}} is {{code|GL_RENDERBUFFER_RED_SIZE}}, {{code|GL_RENDERBUFFER_GREEN_SIZE}}, {{code|GL_RENDERBUFFER_BLUE_SIZE}}, {{code|GL_RENDERBUFFER_ALPHA_SIZE}}, {{code|GL_RENDERBUFFER_DEPTH_SIZE}}, or {{code|GL_RENDERBUFFER_STENCIL_SIZE}}, then {{param|params}} will contain the actual resolutions (not the resolutions specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the renderbuffer currently bound to {{param|target}}. | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|pname}} is not one of the accepted tokens. | ||
== See Also == | == See Also == | ||
{{apifunc|glGenRenderbuffers}}, {{apifunc|glFramebufferRenderbuffer}}, {{apifunc|glBindRenderbuffer}}, {{apifunc|glRenderbufferStorage}}, {{apifunc|glRenderbufferStorageMultisample}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:21, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 3.0 | |
glGetRenderbufferParameteriv: retrieve information about a bound renderbuffer object
Function Definition
void glGetRenderbufferParameteriv(GLenum target, GLenum pname, GLint *params);
- target
- Specifies the target of the query operation. target must be GL_RENDERBUFFER.
- pname
- Specifies the parameter whose value to retrieve from the renderbuffer bound to target.
- params
- Specifies the address of an array to receive the value of the queried parameter.
Description
glGetRenderbufferParameteriv retrieves information about a bound renderbuffer object. target specifies the target of the query operation and must be GL_RENDERBUFFER. pname specifies the parameter whose value to query and must be one of GL_RENDERBUFFER_WIDTH, GL_RENDERBUFFER_HEIGHT, GL_RENDERBUFFER_INTERNAL_FORMAT, GL_RENDERBUFFER_RED_SIZE, GL_RENDERBUFFER_GREEN_SIZE, GL_RENDERBUFFER_BLUE_SIZE, GL_RENDERBUFFER_ALPHA_SIZE, GL_RENDERBUFFER_DEPTH_SIZE, GL_RENDERBUFFER_DEPTH_SIZE, GL_RENDERBUFFER_STENCIL_SIZE, or GL_RENDERBUFFER_SAMPLES.
Upon a successful return from glGetRenderbufferParameteriv, if pname is GL_RENDERBUFFER_WIDTH, GL_RENDERBUFFER_HEIGHT, GL_RENDERBUFFER_INTERNAL_FORMAT, or GL_RENDERBUFFER_SAMPLES, then params will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively, of the image of the renderbuffer currently bound to target.
If pname is GL_RENDERBUFFER_RED_SIZE, GL_RENDERBUFFER_GREEN_SIZE, GL_RENDERBUFFER_BLUE_SIZE, GL_RENDERBUFFER_ALPHA_SIZE, GL_RENDERBUFFER_DEPTH_SIZE, or GL_RENDERBUFFER_STENCIL_SIZE, then params will contain the actual resolutions (not the resolutions specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the renderbuffer currently bound to target.
Errors
GL_INVALID_ENUM is generated if pname is not one of the accepted tokens.
See Also
glGenRenderbuffers, glFramebufferRenderbuffer, glBindRenderbuffer, glRenderbufferStorage, glRenderbufferStorageMultisample
Copyright
Copyright © 2010 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/.