glGetPixelMap(3) glGetPixelMap(3)
NAME
glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv - return the speci-
fied pixel map
C SPECIFICATION
void glGetPixelMapfv( GLenum map,
GLfloat *values )
void glGetPixelMapuiv( GLenum map,
GLuint *values )
void glGetPixelMapusv( GLenum map,
GLushort *values )
PARAMETERS
map Specifies the name of the pixel map to return. Accepted values
are GL_PIXEL_MAP_I_TO_I, GL_PIXEL_MAP_S_TO_S,
GL_PIXEL_MAP_I_TO_R, GL_PIXEL_MAP_I_TO_G, GL_PIXEL_MAP_I_TO_B,
GL_PIXEL_MAP_I_TO_A, GL_PIXEL_MAP_R_TO_R, GL_PIXEL_MAP_G_TO_G,
GL_PIXEL_MAP_B_TO_B, and GL_PIXEL_MAP_A_TO_A.
values Returns the pixel map contents.
DESCRIPTION
See the glPixelMap reference page for a description of the acceptable
values for the map parameter. glGetPixelMap returns in values the con-
tents of the pixel map specified in map. Pixel maps are used during
the execution of glReadPixels, glDrawPixels, glCopyPixels,
glTexImage1D, glTexImage2D, glTexImage3D, glTexSubImage1D,
glTexSubImage2D, glTexSubImage3D, glCopyTexImage1D, glCopyTexImage2D,
glCopyTexSubImage1D, glCopyTexSubImage2D, glCopyTexSubImage3D,
glColorTable, glColorSubTable, glCopyColorTable, glCopyColorSubTable,
glConvolutionFilter1D, glConvolutionFilter2D, glSeparableFilter2D,
glGetHistogram, glGetMinmax, and glGetTexImage to map color indices,
stencil indices, color components, and depth components to other val-
ues.
Unsigned integer values, if requested, are linearly mapped from the
internal fixed or floating-point representation such that 1.0 maps to
the largest representable integer value, and 0.0 maps to 0. Return
unsigned integer values are undefined if the map value was not in the
range [0,1].
To determine the required size of map, call glGet with the appropriate
symbolic constant.
NOTES
If an error is generated, no change is made to the contents of values.
ERRORS
GL_INVALID_ENUM is generated if map is not an accepted value.
GL_INVALID_OPERATION is generated if glGetPixelMap is executed between
the execution of glBegin and the corresponding execution of glEnd.
ASSOCIATED GETS
glGet with argument GL_PIXEL_MAP_I_TO_I_SIZE
glGet with argument GL_PIXEL_MAP_S_TO_S_SIZE
glGet with argument GL_PIXEL_MAP_I_TO_R_SIZE
glGet with argument GL_PIXEL_MAP_I_TO_G_SIZE
glGet with argument GL_PIXEL_MAP_I_TO_B_SIZE
glGet with argument GL_PIXEL_MAP_I_TO_A_SIZE
glGet with argument GL_PIXEL_MAP_R_TO_R_SIZE
glGet with argument GL_PIXEL_MAP_G_TO_G_SIZE
glGet with argument GL_PIXEL_MAP_B_TO_B_SIZE
glGet with argument GL_PIXEL_MAP_A_TO_A_SIZE
glGet with argument GL_MAX_PIXEL_MAP_TABLE
SEE ALSO
glColorSubTable(3), glColorTable(3), glConvolutionFilter1D(3),
glConvolutionFilter2D(3), glCopyColorSubTable(3), glCopyColorTable(3),
glCopyPixels(3), glCopyTexImage1D(3), glCopyTexImage2D(3),
glCopyTexSubImage1D(3), glCopyTexSubImage2D(3), glCopyTexSubImage3D(3),
glDrawPixels(3), glGetHistogram(3), glGetMinmax(3), glGetTexImage(3),
glPixelMap(3), glPixelTransfer(3), glReadPixels(3),
glSeparableFilter2D(3), glTexImage1D(3), glTexImage1D(3),
glTexImage2D(3), glTexImage3D(3), glTexSubImage1D(3), glTexSubImage2D(3),
glTexSubImage3D(3)
glGetPixelMap(3)
Mac OS X 10.6 - Generated Thu Sep 17 20:20:22 CDT 2009