GLGETCOMPRESSEDTEXIMAGE(3gl)GLGETCOMPRESSEDTEXIMAGE(3gl)NAMEglGetCompressedTexImage - return a compressed texture image
C SPECIFICATION
void glGetCompressedTexImage( GLenum target,
GLint lod,
GLvoid *img )
PARAMETERS
target Specifies which texture is to be obtained. One of GL_TEX‐
TURE_1D, GL_TEXTURE_2D, GL_TEXTURE_3D, GL_TEXTURE_CUBE_MAP_POS‐
ITIVE_X, GL_TEXTURE_CUBE_MAP_NEGATIVE_X, GL_TEX‐
TURE_CUBE_MAP_POSITIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
are accepted.
lod Specifies the level-of-detail number of the desired image.
Level 0 is the base image level. Level n is the nth mipmap
reduction image.
img Returns the compressed texture image.
DESCRIPTIONglGetCompressedTexImage is used to obtain texture images stored in com‐
pressed form. The parameters target, lod, and img are interpreted in
the same manner as in glGetTexImage. When called, glGetCompressedTex‐
Image writes GL_TEXTURE_COMPRESSED_IMAGE_SIZE (accepted by glGet‐
TexLevelParameter) ubytes of compressed image data to the memory
pointed to by img. The compressed image data is formatted according to
the definition of the texture's internal format. All pixel storage and
pixel transfer modes are ignored when returning a compressed texture
image.
Calling glGetCompressedTexImage with a texture image stored with an
uncompressed internal format causes an GL_INVALID_OPERATION error.
NOTES
If an error is generated, no change is made to the contents of img.
ERRORS
GL_INVALID_ENUM is generated if target is not an accepted value.
GL_INVALID_VALUE is generated if lod is less than 0.
GL_INVALID_VALUE may be generated if lod is greater than log2max, where
max is the returned value of GL_MAX_TEXTURE_SIZE.
GL_INVALID_OPERATION is generated if glGetCompressedTexImage is exe‐
cuted between the execution of glBegin and the corresponding execution
of glEnd.
ASSOCIATED GETS
glGetTexImage
SEE ALSO
30 Sep 02 GLGETCOMPRESSEDTEXIMAGE(3gl)