[ Previous | Next | Contents | Glossary | Home | Search ]
OpenGL 1.1 for AIX: Reference Manual

glGetPixelMap Subroutine

Purpose

Returns the specified pixel map.

Library

OpenGL C bindings library: libGL.a

C Syntax

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

The glGetPixelMap subroutine returns in the Values parameter the contents of the pixel map specified by the Map parameter. Pixel maps are used during the execution of glReadPixels, glDrawPixels, glCopyPixels, glTexImage1D, and glTexImage2D 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 (zero). Returned unsigned integer values are undefined if the map value was not in the range [0,1].

To determine the required size of the Map parameter, call the glGet subroutine with the appropriate symbolic constant.

Notes

If an error is generated, no change is made to the contents of the Values parameter.

Errors

GL_INVALID_ENUM Map is not an accepted value.
GL_INVALID_OPERATION The glGetPixelMap subroutine is called between a call to glBegin and the corresponding call to glEnd.

Associated Gets

Associated gets for the glGetPixelMap subroutine are as follows. (See the glGet subroutine for more information.)

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.

Files

/usr/include/GL/gl.h Contains C language constants, variable type definitions, and ANSI function prototypes for OpenGL.

Related Information

The glBegin or glEnd subroutine, glCopyPixels subroutine, glDrawPixels subroutine, glPixelMap subroutine, glPixelTransfer subroutine, glReadPixels subroutine, glTexImage1D subroutine, glTexImage2D subroutine.

OpenGL Overview.


[ Previous | Next | Contents | Glossary | Home | Search ]