GLAPI/glRenderbufferStorageMultisample: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
Add arb/ext links
 
(6 intermediate revisions by one other user not shown)
Line 2: Line 2:
| name = glRenderbufferStorageMultisample  
| name = glRenderbufferStorageMultisample  
| core = 3.0
| core = 3.0
| core_extension = {{extref|framebuffer_object}}
| ext_extension = {{extref|framebuffer_multisample|EXT}}
}}
}}


Line 8: Line 10:
== Function Definition ==
== Function Definition ==


   void '''glRenderbufferStorageMultisample'''(GLenum ''target'', GLsizei ''samples'', GLenum ''internalformat'', GLsizei ''width'', GLsizei ''height'');
   void '''glRenderbufferStorageMultisample'''(GLenum {{param|target}}, GLsizei {{param|samples}}, GLenum {{param|internalformat}}, GLsizei {{param|width}}, GLsizei {{param|height}});


; target
; target
: Specifies a binding to which the target of the allocation and must be {{code|GL_RENDERBUFFER}}.
: Specifies a binding to which the target of the allocation and must be {{enum|GL_RENDERBUFFER}}.
; samples
; samples
: Specifies the number of samples to be used for the renderbuffer object's storage.
: Specifies the number of samples to be used for the renderbuffer object's storage.
Line 25: Line 27:
'''glRenderbufferStorageMultisample''' establishes the data storage, format, dimensions and number of samples of a renderbuffer object's image.
'''glRenderbufferStorageMultisample''' establishes the data storage, format, dimensions and number of samples of a renderbuffer object's image.


The target of the operation, specified by ''target'' must be {{code|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 {{code|GL_MAX_RENDERBUFFER_SIZE}}. ''samples'' specifies the number of samples to be used for the renderbuffer object's image, and must be less than or equal to the value of {{code|GL_MAX_SAMPLES}}. If ''internalformat'' is a signed or unsigned integer format then ''samples'' must be less than or equal to the value of {{code|GL_MAX_INTEGER_SAMPLES}}.
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}}. {{param|samples}} specifies the number of samples to be used for the renderbuffer object's image, and must be less than or equal to the value of {{enum|GL_MAX_SAMPLES}}. If {{param|internalformat}} is a signed or unsigned integer format then {{param|samples}} must be less than or equal to the value of {{enum|GL_MAX_INTEGER_SAMPLES}}.


Upon success, '''glRenderbufferStorageMultisample''' deletes any existing data store for the renderbuffer image and the contents of the data store after calling '''glRenderbufferStorageMultisample''' are undefined.
Upon success, '''glRenderbufferStorageMultisample''' deletes any existing data store for the renderbuffer image and the contents of the data store after calling '''glRenderbufferStorageMultisample''' are undefined.
Line 31: Line 33:
== Errors ==
== Errors ==


{{code|GL_INVALID_ENUM}} is generated if ''target'' is not {{code|GL_RENDERBUFFER}}.
{{enum|GL_INVALID_ENUM}} is generated if {{param|target}} is not {{enum|GL_RENDERBUFFER}}.


{{code|GL_INVALID_VALUE}} is generated if ''samples'' is greater than {{code|GL_MAX_SAMPLES}}.
{{enum|GL_INVALID_VALUE}} is generated if {{param|samples}} is greater than {{enum|GL_MAX_SAMPLES}}.


{{code|GL_INVALID_ENUM}} is generated if ''internalformat'' is not a color-renderable, depth-renderable, or stencil-renderable format.
{{enum|GL_INVALID_ENUM}} is generated if {{param|internalformat}} is not a color-renderable, depth-renderable, or stencil-renderable format.


{{code|GL_INVALID_OPERATION}} is generated if ''internalformat'' is a signed or unsigned integer format and ''samples'' is greater than the value of {{code|GL_MAX_INTEGER_SAMPLES}}
{{enum|GL_INVALID_OPERATION}} is generated if {{param|internalformat}} is a signed or unsigned integer format and {{param|samples}} is greater than the value of {{enum|GL_MAX_INTEGER_SAMPLES}}


{{code|GL_INVALID_VALUE}} is generated if either of ''width'' or ''height'' is negative, or greater than the value of {{code|GL_MAX_RENDERBUFFER_SIZE}}.
{{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}}.


{{code|GL_OUT_OF_MEMORY}} is generated if the GL is unable to create a data store of the requested size.
{{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 ==


[[GLAPI/glGenRenderbuffers|glGenRenderbuffers]], [[GLAPI/glBindRenderbuffer|glBindRenderbuffer]], [[GLAPI/glRenderbufferStorage|glRenderbufferStorage]], [[GLAPI/glFramebufferRenderbuffer|glFramebufferRenderbuffer]], [[GLAPI/glDeleteRenderbuffers|glDeleteRenderbuffers]]
{{apifunc|glBindRenderbuffer}}, {{apifunc|glRenderbufferStorage}}, {{apifunc|glFramebufferRenderbuffer}}


== Copyright ==
== Copyright ==
Line 51: Line 53:
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 4|RenderbufferStorageMultisample]]
[[Category:Core API Ref Framebuffer Objects|RenderbufferStorageMultisample]]
[[Category:GL 4 API Framebuffer Objects|RenderbufferStorageMultisample]]
[[Category:Core API Reference|RenderbufferStorageMultisample]]
[[Category:Renderbuffer Object API State Functions|RenderbufferStorageMultisample]]

Latest revision as of 22:09, 31 August 2017

glRenderbufferStorageMultisample
Core in version 4.6
Core since version 3.0
Core ARB extension ARB_framebuffer_object
EXT extension EXT_framebuffer_multisample

glRenderbufferStorageMultisample: establish data storage, format, dimensions and sample count of a renderbuffer object's image

Function Definition

 void glRenderbufferStorageMultisample(GLenum target​, GLsizei samples​, GLenum internalformat​, GLsizei width​, GLsizei height​);
target
Specifies a binding to which the target of the allocation and must be GL_RENDERBUFFER.
samples
Specifies the number of samples to be used for the renderbuffer object's storage.
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

glRenderbufferStorageMultisample establishes the data storage, format, dimensions and number of samples of a renderbuffer object's image.

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. samples​ specifies the number of samples to be used for the renderbuffer object's image, and must be less than or equal to the value of GL_MAX_SAMPLES. If internalformat​ is a signed or unsigned integer format then samples​ must be less than or equal to the value of GL_MAX_INTEGER_SAMPLES.

Upon success, glRenderbufferStorageMultisample deletes any existing data store for the renderbuffer image and the contents of the data store after calling glRenderbufferStorageMultisample are undefined.

Errors

GL_INVALID_ENUM is generated if target​ is not GL_RENDERBUFFER.

GL_INVALID_VALUE is generated if samples​ is greater than GL_MAX_SAMPLES.

GL_INVALID_ENUM is generated if internalformat​ is not a color-renderable, depth-renderable, or stencil-renderable format.

GL_INVALID_OPERATION is generated if internalformat​ is a signed or unsigned integer format and samples​ is greater than the value of GL_MAX_INTEGER_SAMPLES

GL_INVALID_VALUE is generated if either of width​ or height​ is negative, or greater than the value of GL_MAX_RENDERBUFFER_SIZE.

GL_OUT_OF_MEMORY is generated if the GL is unable to create a data store of the requested size.

See Also

glBindRenderbuffer, glRenderbufferStorage, 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/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glRenderbufferStorageMultisample&oldid=13987"