glRenderbufferStorageMultisample — establish data storage, format, dimensions and sample count of a renderbuffer object's image
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.
samplesSpecifies the number of samples to be used for the renderbuffer object's storage.
internalformatSpecifies the internal format to use for the renderbuffer object's image.
widthSpecifies the width of the renderbuffer, in pixels.
heightSpecifies the height of the renderbuffer, in pixels.
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, as shown in Table 1 below.
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. If internalformat is a signed or unsigned integer format then
samples must be 0. Otherwise, samples must be must be less than or equal to
the maximum number of samples supported for internalformat.
(see glGetInternalFormativ).
Upon success, glRenderbufferStorageMultisample deletes any existing data store for the renderbuffer
image and the contents of the data store after calling glRenderbufferStorageMultisample are undefined.
Table 1. Sized Internal Formats
| Sized Internal Format | Base Format | Red Bits | Green Bits | Blue Bits | Alpha Bits |
|---|---|---|---|---|---|
GL_R8 | GL_RED | 8 | |||
GL_R8UI | GL_RED_INTEGER | ui8 | |||
GL_R8I | GL_RED_INTEGER | i8 | |||
GL_R16UI | GL_RED_INTEGER | ui16 | |||
GL_R16I | GL_RED_INTEGER | i16 | |||
GL_R32UI | GL_RED_INTEGER | ui32 | |||
GL_R32I | GL_RED_INTEGER | i32 | |||
GL_RG8 | GL_RG | 8 | 8 | ||
GL_RG8UI | GL_RG_INTEGER | ui8 | ui8 | ||
GL_RG8I | GL_RG_INTEGER | i8 | i8 | ||
GL_RG16UI | GL_RG_INTEGER | ui16 | ui16 | ||
GL_RG16I | GL_RG_INTEGER | i16 | i16 | ||
GL_RG32UI | GL_RG_INTEGER | ui32 | ui32 | ||
GL_RG32I | GL_RG_INTEGER | i32 | i32 | ||
GL_RGB8 | GL_RGB | 8 | 8 | 8 | |
GL_RGB565 | GL_RGB | 5 | 6 | 5 | |
GL_RGBA8 | GL_RGBA | 8 | 8 | 8 | 8 |
GL_SRGB8_ALPHA8 | GL_RGBA | 8 | 8 | 8 | 8 |
GL_RGB5_A1 | GL_RGBA | 5 | 5 | 5 | 1 |
GL_RGBA4 | GL_RGBA | 4 | 4 | 4 | 4 |
GL_RGB10_A2 | GL_RGBA | 10 | 10 | 10 | 2 |
GL_RGBA8UI | GL_RGBA_INTEGER | ui8 | ui8 | ui8 | ui8 |
GL_RGBA8I | GL_RGBA_INTEGER | i8 | i8 | i8 | i8 |
GL_RGB10_A2UI | GL_RGBA_INTEGER | ui10 | ui10 | ui10 | ui2 |
GL_RGBA16UI | GL_RGBA_INTEGER | ui16 | ui16 | ui16 | ui16 |
GL_RGBA16I | GL_RGBA_INTEGER | i16 | i16 | i16 | i16 |
GL_RGBA32I | GL_RGBA_INTEGER | i32 | i32 | i32 | i32 |
GL_RGBA32UI | GL_RGBA_INTEGER | ui32 | ui32 | ui32 | ui32 |
| Sized Internal Format | Base Format | Depth Bits | Stencil Bits |
|---|---|---|---|
GL_DEPTH_COMPONENT16 | GL_DEPTH_COMPONENT | 16 | |
GL_DEPTH_COMPONENT24 | GL_DEPTH_COMPONENT | 24 | |
GL_DEPTH_COMPONENT32F | GL_DEPTH_COMPONENT | f32 | |
GL_DEPTH24_STENCIL8 | GL_DEPTH_STENCIL | 24 | 8 |
GL_DEPTH32F_STENCIL8 | GL_DEPTH_STENCIL | f32 | 8 |
GL_STENCIL_INDEX8 | GL_STENCIL | 8 |
Since different implementations may support different sample counts for multisample
rendering, the actual number of samples allocated for the renderbuffer image is
implementation-dependent. However, the resulting value for GL_RENDERBUFFER_SAMPLES
is guaranteed to be greater than or equal to samples and no more than the
next larger sample count supported by the implementation.
GL_INVALID_ENUM is generated if target is not GL_RENDERBUFFER.
GL_INVALID_VALUE is generated if samples is greater than the maximum number of samples
supported for internalformat.
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 0.
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.
glGenRenderbuffers, glGetInternalFormativ, glBindRenderbuffer, glRenderbufferStorage, glFramebufferRenderbuffer, glDeleteRenderbuffers
Copyright © 2010-2012 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/.