GLAPI/glRenderbufferStorage: Difference between revisions
4.0 API. |
Add core/ext extrefs |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
| name = glRenderbufferStorage | | name = glRenderbufferStorage | ||
| core = 3.0 | | core = 3.0 | ||
| core_extension = {{extref|framebuffer_object}} | |||
| ext_extension = {{extref|framebuffer_object|EXT}} | |||
}} | }} | ||
| Line 8: | Line 10: | ||
== Function Definition == | == Function Definition == | ||
void '''glRenderbufferStorage'''(GLenum | void '''glRenderbufferStorage'''(GLenum {{param|target}}, GLenum {{param|internalformat}}, GLsizei {{param|width}}, GLsizei {{param|height}}); | ||
; target | ; target | ||
: Specifies a binding to which the target of the allocation and must be {{ | : Specifies a binding to which the target of the allocation and must be {{enum|GL_RENDERBUFFER}}. | ||
; internalformat | ; internalformat | ||
: Specifies the internal format to use for the renderbuffer object's image. | : Specifies the internal format to use for the renderbuffer object's image. | ||
| Line 21: | Line 23: | ||
== Description == | == Description == | ||
'''glRenderbufferStorage''' is equivalent to calling | '''glRenderbufferStorage''' is equivalent to calling {{apifunc|glRenderbufferStorageMultisample}} with the {{param|samples}} set to zero. | ||
The target of the operation, specified by | The target of the operation, specified by {{param|target}} must be {{enum|GL_RENDERBUFFER}}. {{param|internalformat}} specifies the internal format to be used for the renderbuffer object's storage and must be a color-renderable, depth-renderable, or stencil-renderable format. {{param|width}} and {{param|height}} are the dimensions, in pixels, of the renderbuffer. Both {{param|width}} and {{param|height}} must be less than or equal to the value of {{enum|GL_MAX_RENDERBUFFER_SIZE}}. | ||
Upon success, '''glRenderbufferStorage''' deletes any existing data store for the renderbuffer image and the contents of the data store after calling '''glRenderbufferStorage''' are undefined. | Upon success, '''glRenderbufferStorage''' deletes any existing data store for the renderbuffer image and the contents of the data store after calling '''glRenderbufferStorage''' are undefined. | ||
| Line 29: | Line 31: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|target}} is not {{enum|GL_RENDERBUFFER}}. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if either of {{param|width}} or {{param|height}} is negative, or greater than the value of {{enum|GL_MAX_RENDERBUFFER_SIZE}}. | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|internalformat}} is not a color-renderable, depth-renderable, or stencil-renderable format. | ||
{{ | {{enum|GL_OUT_OF_MEMORY}} is generated if the GL is unable to create a data store of the requested size. | ||
== See Also == | == See Also == | ||
{{apifunc|glBindRenderbuffer}}, {{apifunc|glRenderbufferStorageMultisample}}, {{apifunc|glFramebufferRenderbuffer}} | |||
* [[Required Image Format|Required internal formats]] | |||
== Copyright == | == Copyright == | ||
| Line 45: | Line 49: | ||
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/ http://opencontent.org/openpub/]. | 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/ http://opencontent.org/openpub/]. | ||
[[Category:API Reference | [[Category:Core API Ref Framebuffer Objects|RenderbufferStorage]] | ||
[[Category:Core API Reference|RenderbufferStorage]] | |||
[[Category:Renderbuffer Object API State Functions|RenderbufferStorage]] | |||
Latest revision as of 22:03, 31 August 2017
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 3.0 | |
| Core ARB extension | ARB_framebuffer_object | |
| EXT extension | EXT_framebuffer_object | |
glRenderbufferStorage: establish data storage, format and dimensions of a renderbuffer object's image
Function Definition
void glRenderbufferStorage(GLenum target, GLenum internalformat, GLsizei width, GLsizei height);
- target
- Specifies a binding to which the target of the allocation and must be GL_RENDERBUFFER.
- internalformat
- Specifies the internal format to use for the renderbuffer object's image.
- width
- Specifies the width of the renderbuffer, in pixels.
- height
- Specifies the height of the renderbuffer, in pixels.
Description
glRenderbufferStorage is equivalent to calling glRenderbufferStorageMultisample with the samples set to zero.
The target of the operation, specified by target must be GL_RENDERBUFFER. internalformat specifies the internal format to be used for the renderbuffer object's storage and must be a color-renderable, depth-renderable, or stencil-renderable format. width and height are the dimensions, in pixels, of the renderbuffer. Both width and height must be less than or equal to the value of GL_MAX_RENDERBUFFER_SIZE.
Upon success, glRenderbufferStorage deletes any existing data store for the renderbuffer image and the contents of the data store after calling glRenderbufferStorage are undefined.
Errors
GL_INVALID_ENUM is generated if target is not GL_RENDERBUFFER.
GL_INVALID_VALUE is generated if either of width or height is negative, or greater than the value of GL_MAX_RENDERBUFFER_SIZE.
GL_INVALID_ENUM is generated if internalformat is not a color-renderable, depth-renderable, or stencil-renderable format.
GL_OUT_OF_MEMORY is generated if the GL is unable to create a data store of the requested size.
See Also
glBindRenderbuffer, glRenderbufferStorageMultisample, glFramebufferRenderbuffer
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/.