NAME

glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv - return the specified pixel map

C SPECIFICATION

void ggllGGeettPPiixxeellMMaappffvv( GLenum _m_a_p,
                      GLfloat _*_v_a_l_u_e_s )
void ggllGGeettPPiixxeellMMaappuuiivv( GLenum _m_a_p,
                       GLuint _*_v_a_l_u_e_s )
void ggllGGeettPPiixxeellMMaappuussvv( GLenum _m_a_p,
                       GLushort _*_v_a_l_u_e_s )

PARAMETERS

_m_a_p
Specifies the name of the pixel map to return. Accepted values are GGLL__PPIIXXEELL__MMAAPP__II__TTOO__II, GGLL__PPIIXXEELL__MMAAPP__SS__TTOO__SS, GGLL__PPIIXXEELL__MMAAPP__II__TTOO__RR, GGLL__PPIIXXEELL__MMAAPP__II__TTOO__GG, GGLL__PPIIXXEELL__MMAAPP__II__TTOO__BB, GGLL__PPIIXXEELL__MMAAPP__II__TTOO__AA, GGLL__PPIIXXEELL__MMAAPP__RR__TTOO__RR, GGLL__PPIIXXEELL__MMAAPP__GG__TTOO__GG, GGLL__PPIIXXEELL__MMAAPP__BB__TTOO__BB, and GGLL__PPIIXXEELL__MMAAPP__AA__TTOO__AA.
_v_a_l_u_e_s
Returns the pixel map contents.

DESCRIPTION

See the ggllPPiixxeellMMaapp reference page for a description of the acceptable values for the _m_a_p parameter. ggllGGeettPPiixxeellMMaapp returns in _v_a_l_u_e_s the contents of the pixel map specified in _m_a_p. Pixel maps are used during the execution of ggllRReeaaddPPiixxeellss, ggllDDrraawwPPiixxeellss, ggllCCooppyyPPiixxeellss, ggllTTeexxIImmaaggee11DD, ggllTTeexxIImmaaggee22DD, ggllTTeexxIImmaaggee33DD, ggllTTeexxSSuubbIImmaaggee11DD, ggllTTeexxSSuubbIImmaaggee22DD, ggllTTeexxSSuubbIImmaaggee33DD, ggllCCooppyyTTeexxIImmaaggee11DD, ggllCCooppyyTTeexxIImmaaggee22DD, ggllCCooppyyTTeexxSSuubbIImmaaggee11DD, ggllCCooppyyTTeexxSSuubbIImmaaggee22DD, ggllCCooppyyTTeexxSSuubbIImmaaggee33DD, ggllCCoolloorrTTaabbllee, ggllCCoolloorrSSuubbTTaabbllee, ggllCCooppyyCCoolloorrTTaabbllee, ggllCCooppyyCCoolloorrSSuubbTTaabbllee, ggllCCoonnvvoolluuttiioonnFFiilltteerr11DD, ggllCCoonnvvoolluuttiioonnFFiilltteerr22DD, ggllSSeeppaarraabblleeFFiilltteerr22DD, ggllGGeettHHiissttooggrraamm, ggllGGeettMMiinnmmaaxx, and ggllGGeettTTeexxIImmaaggee 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 _m_a_p, call ggllGGeett with the appropriate symbolic constant.

NOTES

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

ERRORS

GGLL__IINNVVAALLIIDD__EENNUUMM is generated if _m_a_p is not an accepted value.

GGLL__IINNVVAALLIIDD__OOPPEERRAATTIIOONN is generated if ggllGGeettPPiixxeellMMaapp is executed between the execution of ggllBBeeggiinn and the corresponding execution of ggllEEnndd.

ASSOCIATED GETS

ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__II__TTOO__II__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__SS__TTOO__SS__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__II__TTOO__RR__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__II__TTOO__GG__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__II__TTOO__BB__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__II__TTOO__AA__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__RR__TTOO__RR__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__GG__TTOO__GG__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__BB__TTOO__BB__SSIIZZEE
ggllGGeett with argument GGLL__PPIIXXEELL__MMAAPP__AA__TTOO__AA__SSIIZZEE
ggllGGeett with argument GGLL__MMAAXX__PPIIXXEELL__MMAAPP__TTAABBLLEE

SEE ALSO

ggllCCoolloorrSSuubbTTaabbllee((33GG)), ggllCCoolloorrTTaabbllee((33GG)), ggllCCoonnvvoolluuttiioonnFFiilltteerr11DD((33GG)), ggllCCoonnvvoolluuttiioonnFFiilltteerr22DD((33GG)), ggllCCooppyyCCoolloorrSSuubbTTaabbllee((33GG)), ggllCCooppyyCCoolloorrTTaabbllee((33GG)), ggllCCooppyyPPiixxeellss((33GG)), ggllCCooppyyTTeexxIImmaaggee11DD((33GG)), ggllCCooppyyTTeexxIImmaaggee22DD((33GG)), ggllCCooppyyTTeexxSSuubbIImmaaggee11DD((33GG)), ggllCCooppyyTTeexxSSuubbIImmaaggee22DD((33GG)), ggllCCooppyyTTeexxSSuubbIImmaaggee33DD((33GG)), ggllDDrraawwPPiixxeellss((33GG)), ggllGGeettHHiissttooggrraamm((33GG)), ggllGGeettMMiinnmmaaxx((33GG)), ggllGGeettTTeexxIImmaaggee((33GG)), ggllPPiixxeellMMaapp((33GG)), ggllPPiixxeellTTrraannssffeerr((33GG)), ggllRReeaaddPPiixxeellss((33GG)), ggllSSeeppaarraabblleeFFiilltteerr22DD((33GG)), ggllTTeexxIImmaaggee11DD((33GG)), ggllTTeexxIImmaaggee22DD((33GG)) ggllTTeexxIImmaaggee33DD((33GG)), ggllTTeexxSSuubbIImmaaggee11DD((33GG)), ggllTTeexxSSuubbIImmaaggee22DD((33GG)), ggllTTeexxSSuubbIImmaaggee33DD((33GG))