glTexStorage2DMultisample

From OpenGL Reference
Jump to navigation Jump to search

Specify storage for a two-dimensional multisample texture.

C Specification[edit]

void glTexStorage2DMultisample( GLenum target, GLsizei samples, GLenum internalformat, GLsizei width, GLsizei height, GLboolean fixedsamplelocations );
void glTextureStorage2DMultisample( GLuint texture, GLsizei samples, GLenum internalformat, GLsizei width, GLsizei height, GLboolean fixedsamplelocations );


Parameters[edit]

target - Specifies the target to which the texture object is bound for glTexStorage2DMultisample . Must be one of GL_TEXTURE_2D_MULTISAMPLE or GL_PROXY_TEXTURE_2D_MULTISAMPLE .
texture - Specifies the texture object name for glTextureStorage2DMultisample . The effective target of texture must be one of the valid non-proxy target values above.
samples - Specify the number of samples in the texture.
internalformat - Specifies the sized internal format to be used to store texture image data.
width - Specifies the width of the texture, in texels.
height - Specifies the height of the texture, in texels.
fixedsamplelocations - Specifies whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image.


Description[edit]

 glTexStorage2DMultisample and glTextureStorage2DMultisample specify the storage requirements for a two-dimensional multisample texture. Once a texture is specified with this command, its format and dimensions become immutable unless it is a proxy texture. The contents of the image may still be modified, however, its storage requirements may not change. Such a texture is referred to as animmutable-formattexture.

 samples specifies the number of samples to be used for the texture and must be greater than zero and less than or equal to the value of GL_MAX_SAMPLES . internalformat must be a color-renderable, depth-renderable, or stencil-renderable format. width and height specify the width and height, respectively, of the texture. If fixedsamplelocations is GL_TRUE , the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image.



Errors[edit]

 GL_INVALID_OPERATION is generated by glTexStorage2DMultisample if zero is bound to target .

 GL_INVALID_OPERATION is generated by glTextureStorage2DMultisample if texture is not the name of an existing texture object.

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

 GL_INVALID_ENUM is generated if target or the effective target of texture is not one of the accepted targets described above.

 GL_INVALID_VALUE is generated if width or height are less than 1 or greater than the value of GL_MAX_TEXTURE_SIZE .

 GL_INVALID_VALUE is generated if levels is less than 1.

 GL_INVALID_VALUE is generated if samples is zero.

 GL_INVALID_OPERATION is generated if samples is greater than the maximum number of samples supported for this target and internalformat .

 GL_INVALID_OPERATION is generated if the value of GL_TEXTURE_IMMUTABLE_FORMAT for the texture bound to target is not GL_FALSE .


Version Support[edit]

 glTexStorage2DMultisample  4.3+
 glTextureStorage2DMultisample  4.5+

See Also[edit]

 glTexImage2D , glTexImage2DMultisample , glTexStorage1D , glTexStorage3D .


Copyright[edit]

Copyright© 2013-2014 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/.