This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

GLGETPIXELMAP(3G)                                                                          GLGETPIXELMAP(3G)



NAME
       glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv - return the specified 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 contents 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 values.

       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(3G), glColorTable(3G), glConvolutionFilter1D(3G), glConvolutionFilter2D(3G), glCopyColorSubTable(3G),
       glCopyColorTable(3G), glCopyPixels(3G), glCopyTexImage1D(3G), glCopyTexImage2D(3G), glCopyTexSubImage1D(3G),
       glCopyTexSubImage2D(3G), glCopyTexSubImage3D(3G), glDrawPixels(3G), glGetHistogram(3G), glGetMinmax(3G), glGetTexImage(3G),
       glPixelMap(3G), glPixelTransfer(3G), glReadPixels(3G), glSeparableFilter2D(3G), glTexImage1D(3G), glTexImage1D(3G),
       glTexImage2D(3G) glTexImage2D(3G), glTexImage3D(3G), glTexSubImage1D(3G), glTexSubImage2D(3G), glTexSubImage3D(3G)




                                                                                           GLGETPIXELMAP(3G)