Difference between revisions of "GLAPI/glTexStorage2D"

From OpenGL.org
Jump to: navigation, search
(Clarification.)
(Compressed formats.)
(3 intermediate revisions by 2 users not shown)
Line 12: Line 12:
  
 
; target
 
; target
: Specify the target of the operation. {{param|target}} must be one of {{enum|GL_TEXTURE_2D}}, {{enum|GL_PROXY_TEXTURE_2D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_PROXY_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_PROXY_TEXTURE_RECTANGLE}}, or {{enum|GL_PROXY_TEXTURE_CUBE_MAP}}.
+
: Specify the target of the operation. {{param|target}} must be one of {{enum|GL_TEXTURE_2D}}, {{enum|GL_PROXY_TEXTURE_2D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_PROXY_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_PROXY_TEXTURE_RECTANGLE}}, {{enum|GL_TEXTURE_CUBE_MAP}}, or {{enum|GL_PROXY_TEXTURE_CUBE_MAP}}.
 
; levels
 
; levels
 
: Specify the number of texture levels.
 
: Specify the number of texture levels.
Line 63: Line 63:
 
Since no texture data is actually provided, the values used in the pseudo-code for {{param|format}} and {{param|type}} are irrelevant and may be considered to be any values that are legal for the chosen {{param|internalformat}} enumerant. {{param|internalformat}} must be one of the sized internal formats given in Table 1 below, one of the sized depth-component formats {{enum|GL_DEPTH_COMPONENT32F}}, {{enum|GL_DEPTH_COMPONENT24}}, or {{enum|GL_DEPTH_COMPONENT16}}, or one of the combined depth-stencil formats, {{enum|GL_DEPTH32F_STENCIL8}}, or {{enum|GL_DEPTH24_STENCIL8}}. Upon success, the value of {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}} becomes {{enum|GL_TRUE}}. The value of {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}} may be discovered by calling [[GLAPI/glGetTexParameter|glGetTexParameter]] with ''pname'' set to {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}}. No further changes to the dimensions or format of the texture object may be made. Using any command that might alter the dimensions or format of the texture object (such as [[GLAPI/glTexImage2D|glTexImage2D]] or another call to '''glTexStorage2D''') will result in the generation of a {{enum|GL_INVALID_OPERATION}} error, even if it would not, in fact, alter the dimensions or format of the object.
 
Since no texture data is actually provided, the values used in the pseudo-code for {{param|format}} and {{param|type}} are irrelevant and may be considered to be any values that are legal for the chosen {{param|internalformat}} enumerant. {{param|internalformat}} must be one of the sized internal formats given in Table 1 below, one of the sized depth-component formats {{enum|GL_DEPTH_COMPONENT32F}}, {{enum|GL_DEPTH_COMPONENT24}}, or {{enum|GL_DEPTH_COMPONENT16}}, or one of the combined depth-stencil formats, {{enum|GL_DEPTH32F_STENCIL8}}, or {{enum|GL_DEPTH24_STENCIL8}}. Upon success, the value of {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}} becomes {{enum|GL_TRUE}}. The value of {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}} may be discovered by calling [[GLAPI/glGetTexParameter|glGetTexParameter]] with ''pname'' set to {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}}. No further changes to the dimensions or format of the texture object may be made. Using any command that might alter the dimensions or format of the texture object (such as [[GLAPI/glTexImage2D|glTexImage2D]] or another call to '''glTexStorage2D''') will result in the generation of a {{enum|GL_INVALID_OPERATION}} error, even if it would not, in fact, alter the dimensions or format of the object.
  
{{glapi internalformattable}}
+
{{glapi internalformattable|line-height: 1.0em;}}
 +
 
 +
{{glapi compressedformattable|line-height: 1.0em;}}
  
 
== Errors ==
 
== Errors ==
Line 79: Line 81:
 
== See Also ==
 
== See Also ==
  
{{apifunc|glTexImage2D}}, {{apifunc|glTexStorage1D}}, {{apifunc|glTexStorage3D}}.
+
{{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}, {{apifunc|glTexStorage1D}}, {{apifunc|glTexStorage2DMultisample}}, {{apifunc|glTexStorage3D}}, {{apifunc|glTexStorage3DMultisample}}, {{apifunc|glTextureView}}, {{apifunc|glTexSubImage2D}}
 +
 
 +
[[S3_Texture_Compression#View_textures_and_S3TC|View textures and S3TC compressed formats]]
  
 
== Copyright ==
 
== Copyright ==

Revision as of 01:56, 14 January 2013

glTexStorage2D
Core in version 4.5
Core since version 4.2
Core ARB extension ARB_texture_storage

glTexStorage2D: simultaneously specify storage for all levels of a two-dimensional or one-dimensional array texture

Function Definition

 void glTexStorage2D(GLenum target​, GLsizei levels​, GLenum internalformat​, GLsizei width​, GLsizei height​);
target
Specify the target of the operation. target​ must be one of GL_TEXTURE_2D, GL_PROXY_TEXTURE_2D, GL_TEXTURE_1D_ARRAY, GL_PROXY_TEXTURE_1D_ARRAY, GL_TEXTURE_RECTANGLE, GL_PROXY_TEXTURE_RECTANGLE, GL_TEXTURE_CUBE_MAP, or GL_PROXY_TEXTURE_CUBE_MAP.
levels
Specify the number of texture levels.
internalformat
Specifies the internal format to be used to store texture image data. This must be a sized image format.
width
Specifies the width of the texture, in texels.
height
Specifies the height of the texture, in texels.

Description

glTexStorage2D specifies the storage requirements for all levels of a two-dimensional texture or one-dimensional texture array simultaneously. Once a texture is specified with this command, the format and dimensions of all levels 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 an immutable-format texture.

The behavior of glTexStorage2D depends on the target​ parameter. When target​ is GL_TEXTURE_2D, GL_PROXY_TEXTURE_2D, GL_TEXTURE_RECTANGLE, GL_PROXY_TEXTURE_RECTANGLE or GL_PROXY_TEXTURE_CUBE_MAP, calling glTexStorage2D is equivalent, assuming no errors are generated, to executing the following pseudo-code:

for (i = 0; i < levels; i++)
{
    glTexImage2D(target, i, internalformat, width, height, 0, format, type, NULL);
    width = max(1, (width / 2));
    height = max(1, (height / 2));
}

When target​ is GL_TEXTURE_CUBE_MAP, glTexStorage2D is equivalent to:

for (i = 0; i < levels; i++)
{
    for (face in (+X, -X, +Y, -Y, +Z, -Z))
    {
        glTexImage2D(face, i, internalformat, width, height, 0, format, type, NULL);
    }
    width = max(1, (width / 2));
    height = max(1, (height / 2));
}

When target​ is GL_TEXTURE_1D or GL_TEXTURE_1D_ARRAY, glTexStorage2D is equivalent to:

for (i = 0; i < levels; i++)
{
    glTexImage2D(target, i, internalformat, width, height, 0, format, type, NULL);
    width = max(1, (width / 2));
}

Since no texture data is actually provided, the values used in the pseudo-code for format​ and type​ are irrelevant and may be considered to be any values that are legal for the chosen internalformat​ enumerant. internalformat​ must be one of the sized internal formats given in Table 1 below, one of the sized depth-component formats GL_DEPTH_COMPONENT32F, GL_DEPTH_COMPONENT24, or GL_DEPTH_COMPONENT16, or one of the combined depth-stencil formats, GL_DEPTH32F_STENCIL8, or GL_DEPTH24_STENCIL8. Upon success, the value of GL_TEXTURE_IMMUTABLE_FORMAT becomes GL_TRUE. The value of GL_TEXTURE_IMMUTABLE_FORMAT may be discovered by calling glGetTexParameter with pname set to GL_TEXTURE_IMMUTABLE_FORMAT. No further changes to the dimensions or format of the texture object may be made. Using any command that might alter the dimensions or format of the texture object (such as glTexImage2D or another call to glTexStorage2D) will result in the generation of a GL_INVALID_OPERATION error, even if it would not, in fact, alter the dimensions or format of the object.

Sized Internal Formats
Component Bitdepth
Sized Internal Format Base Internal Format Red Green Blue Alpha Shared
GL_R8 GL_RED 8
GL_R8_SNORM GL_RED s8
GL_R16 GL_RED 16
GL_R16_SNORM GL_RED s16
GL_RG8 GL_RG 8 8
GL_RG8_SNORM GL_RG s8 s8
GL_RG16 GL_RG 16 16
GL_RG16_SNORM GL_RG s16 s16
GL_R3_G3_B2 GL_RGB 3 3 2
GL_RGB4 GL_RGB 4 4 4
GL_RGB5 GL_RGB 5 5 5
GL_RGB8 GL_RGB 8 8 8
GL_RGB8_SNORM GL_RGB s8 s8 s8
GL_RGB10 GL_RGB 10 10 10
GL_RGB12 GL_RGB 12 12 12
GL_RGB16_SNORM GL_RGB 16 16 16
GL_RGBA2 GL_RGB 2 2 2 2
GL_RGBA4 GL_RGB 4 4 4 4
GL_RGB5_A1 GL_RGBA 5 5 5 1
GL_RGBA8 GL_RGBA 8 8 8 8
GL_RGBA8_SNORM GL_RGBA s8 s8 s8 s8
GL_RGB10_A2 GL_RGBA 10 10 10 2
GL_RGB10_A2UI GL_RGBA ui10 ui10 ui10 ui2
GL_RGBA12 GL_RGBA 12 12 12 12
GL_RGBA16 GL_RGBA 16 16 16 16
GL_SRGB8 GL_RGB 8 8 8
GL_SRGB8_ALPHA8 GL_RGBA 8 8 8 8
GL_R16F GL_RED f16
GL_RG16F GL_RG f16 f16
GL_RGB16F GL_RGB f16 f16 f16
GL_RGBA16F GL_RGBA f16 f16 f16 f16
GL_R32F GL_RED f32
GL_RG32F GL_RG f32 f32
GL_RGB32F GL_RGB f32 f32 f32
GL_RGBA32F GL_RGBA f32 f32 f32 f32
GL_R11F_G11F_B10F GL_RGB f11 f11 f10
GL_RGB9_E5 GL_RGB 9 9 9 5
GL_R8I GL_RED i8
GL_R8UI GL_RED ui8
GL_R16I GL_RED i16
GL_R16UI GL_RED ui16
GL_R32I GL_RED i32
GL_R32UI GL_RED ui32
GL_RG8I GL_RG i8 i8
GL_RG8UI GL_RG ui8 ui8
GL_RG16I GL_RG i16 i16
GL_RG16UI GL_RG ui16 ui16
GL_RG32I GL_RG i32 i32
GL_RG32UI GL_RG ui32 ui32
GL_RGB8I GL_RGB i8 i8 i8
GL_RGB8UI GL_RGB ui8 ui8 ui8
GL_RGB16I GL_RGB i16 i16 i16
GL_RGB16UI GL_RGB ui16 ui16 ui16
GL_RGB32I GL_RGB i32 i32 i32
GL_RGB32UI GL_RGB ui32 ui32 ui32
GL_RGBA8I GL_RGBA i8 i8 i8 i8
GL_RGBA8UI GL_RGBA ui8 ui8 ui8 ui8
GL_RGBA16I GL_RGBA i16 i16 i16 i16
GL_RGBA16UI GL_RGBA ui16 ui16 ui16 ui16
GL_RGBA32I GL_RGBA i32 i32 i32 i32
GL_RGBA32UI GL_RGBA ui32 ui32 ui32 ui32


Compressed Internal Formats
Compressed Internal Format Base Internal Format Type
GL_COMPRESSED_RED GL_RED Generic
GL_COMPRESSED_RG GL_RG Generic
GL_COMPRESSED_RGB GL_RGB Generic
GL_COMPRESSED_RGBA GL_RGBA Generic
GL_COMPRESSED_SRGB GL_RGB Generic
GL_COMPRESSED_SRGB_ALPHA GL_RGBA Generic
GL_COMPRESSED_RED_RGTC1 GL_RED Specific
GL_COMPRESSED_SIGNED_RED_RGTC1 GL_RED Specific
GL_COMPRESSED_RG_RGTC2 GL_RG Specific
GL_COMPRESSED_SIGNED_RG_RGTC2 GL_RG Specific
GL_COMPRESSED_RGBA_BPTC_UNORM GL_RGBA Specific
GL_COMPRESSED_SRGB_ALPHA_BPTC_UNORM GL_RGBA Specific
GL_COMPRESSED_RGB_BPTC_SIGNED_FLOAT GL_RGB Specific
GL_COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT GL_RGB Specific
S3TC formats
GL_COMPRESSED_RGB_S3TC_DXT1_EXT GL_RGB Specific
GL_COMPRESSED_SRGB_S3TC_DXT1_EXT GL_RGB Specific
GL_COMPRESSED_RGBA_S3TC_DXT1_EXT GL_RGBA Specific
GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT1_EXT GL_RGBA Specific
GL_COMPRESSED_RGBA_S3TC_DXT3_EXT GL_RGBA Specific
GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT GL_RGBA Specific
GL_COMPRESSED_RGBA_S3TC_DXT5_EXT GL_RGBA Specific
GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT GL_RGBA Specific


Errors

GL_INVALID_ENUM is generated if internalformat​ is not a valid sized internal format.

GL_INVALID_ENUM is generated if target​ is not one of the accepted target enumerants.

GL_INVALID_VALUE is generated if width​ or levels​ are less than 1.

GL_INVALID_OPERATION is generated if target​ is GL_TEXTURE_1D_ARRAY or GL_PROXY_TEXTURE_1D_ARRAY and levels​ is greater than \left\lfloor \log _{2}(width)\right\rfloor +1.

GL_INVALID_OPERATION is generated if target​ is not GL_TEXTURE_1D_ARRAY or GL_PROXY_TEXTURE_1D_ARRAY and levels​ is greater than \left\lfloor \log _{2}(max(width,height))\right\rfloor +1.

See Also

glActiveTexture, glBindTexture, glTexStorage1D, glTexStorage2DMultisample, glTexStorage3D, glTexStorage3DMultisample, glTextureView, glTexSubImage2D

View textures and S3TC compressed formats

Copyright

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