1GLGETPIXELMAP(3G)                OpenGL Manual               GLGETPIXELMAP(3G)
2
3
4

NAME

6       glGetPixelMap - return the specified pixel map
7

C SPECIFICATION

9       void glGetPixelMapfv(GLenum map, GLfloat * data);
10
11       void glGetPixelMapuiv(GLenum map, GLuint * data);
12
13       void glGetPixelMapusv(GLenum map, GLushort * data);
14

PARAMETERS

16       map
17           Specifies the name of the pixel map to return. Accepted values are
18           GL_PIXEL_MAP_I_TO_I, GL_PIXEL_MAP_S_TO_S, GL_PIXEL_MAP_I_TO_R,
19           GL_PIXEL_MAP_I_TO_G, GL_PIXEL_MAP_I_TO_B, GL_PIXEL_MAP_I_TO_A,
20           GL_PIXEL_MAP_R_TO_R, GL_PIXEL_MAP_G_TO_G, GL_PIXEL_MAP_B_TO_B, and
21           GL_PIXEL_MAP_A_TO_A.
22
23       data
24           Returns the pixel map contents.
25

DESCRIPTION

27       See the glPixelMap() reference page for a description of the acceptable
28       values for the map parameter.  glGetPixelMap returns in data the
29       contents of the pixel map specified in map. Pixel maps are used during
30       the execution of glReadPixels(), glDrawPixels(), glCopyPixels(),
31       glTexImage1D(), glTexImage2D(), glTexImage3D(), glTexSubImage1D(),
32       glTexSubImage2D(), glTexSubImage3D(), glCopyTexImage1D(),
33       glCopyTexImage2D(), glCopyTexSubImage1D(), glCopyTexSubImage2D(), and
34       glCopyTexSubImage3D(). to map color indices, stencil indices, color
35       components, and depth components to other values.
36
37       If a non-zero named buffer object is bound to the GL_PIXEL_PACK_BUFFER
38       target (see glBindBuffer()) while a pixel map is requested, data is
39       treated as a byte offset into the buffer object's data store.
40
41       Unsigned integer values, if requested, are linearly mapped from the
42       internal fixed or floating-point representation such that 1.0 maps to
43       the largest representable integer value, and 0.0 maps to 0. Return
44       unsigned integer values are undefined if the map value was not in the
45       range [0,1].
46
47       To determine the required size of map, call glGet() with the
48       appropriate symbolic constant.
49

NOTES

51       If an error is generated, no change is made to the contents of data.
52

ERRORS

54       GL_INVALID_ENUM is generated if map is not an accepted value.
55
56       GL_INVALID_OPERATION is generated if a non-zero buffer object name is
57       bound to the GL_PIXEL_PACK_BUFFER target and the buffer object's data
58       store is currently mapped.
59
60       GL_INVALID_OPERATION is generated if a non-zero buffer object name is
61       bound to the GL_PIXEL_PACK_BUFFER target and the data would be packed
62       to the buffer object such that the memory writes required would exceed
63       the data store size.
64
65       GL_INVALID_OPERATION is generated by glGetPixelMapfv if a non-zero
66       buffer object name is bound to the GL_PIXEL_PACK_BUFFER target and data
67       is not evenly divisible into the number of bytes needed to store in
68       memory a GLfloat datum.
69
70       GL_INVALID_OPERATION is generated by glGetPixelMapuiv if a non-zero
71       buffer object name is bound to the GL_PIXEL_PACK_BUFFER target and data
72       is not evenly divisible into the number of bytes needed to store in
73       memory a GLuint datum.
74
75       GL_INVALID_OPERATION is generated by glGetPixelMapusv if a non-zero
76       buffer object name is bound to the GL_PIXEL_PACK_BUFFER target and data
77       is not evenly divisible into the number of bytes needed to store in
78       memory a GLushort datum.
79
80       GL_INVALID_OPERATION is generated if glGetPixelMap is executed between
81       the execution of glBegin() and the corresponding execution of glEnd().
82

ASSOCIATED GETS

84       glGet() with argument GL_PIXEL_MAP_I_TO_I_SIZE
85
86       glGet() with argument GL_PIXEL_MAP_S_TO_S_SIZE
87
88       glGet() with argument GL_PIXEL_MAP_I_TO_R_SIZE
89
90       glGet() with argument GL_PIXEL_MAP_I_TO_G_SIZE
91
92       glGet() with argument GL_PIXEL_MAP_I_TO_B_SIZE
93
94       glGet() with argument GL_PIXEL_MAP_I_TO_A_SIZE
95
96       glGet() with argument GL_PIXEL_MAP_R_TO_R_SIZE
97
98       glGet() with argument GL_PIXEL_MAP_G_TO_G_SIZE
99
100       glGet() with argument GL_PIXEL_MAP_B_TO_B_SIZE
101
102       glGet() with argument GL_PIXEL_MAP_A_TO_A_SIZE
103
104       glGet() with argument GL_MAX_PIXEL_MAP_TABLE
105
106       glGet() with argument GL_PIXEL_PACK_BUFFER_BINDING
107

SEE ALSO

109       glColorSubTable(), glColorTable(), glConvolutionFilter1D(),
110       glConvolutionFilter2D(), glCopyColorSubTable(), glCopyColorTable(),
111       glCopyPixels(), glCopyTexImage1D(), glCopyTexImage2D(),
112       glCopyTexSubImage1D(), glCopyTexSubImage2D(), glCopyTexSubImage3D(),
113       glDrawPixels(), glGetHistogram(), glGetMinmax(), glGetTexImage(),
114       glPixelMap(), glPixelTransfer(), glReadPixels(), glSeparableFilter2D(),
115       glTexImage1D(), glTexImage1D(), glTexImage2D()glTexImage2D(),
116       glTexImage3D(), glTexSubImage1D(), glTexSubImage2D(), glTexSubImage3D()
117

119       Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed
120       under the SGI Free Software B License. For details, see
121       http://oss.sgi.com/projects/FreeB/.
122

AUTHORS

124       opengl.org
125
126
127
128opengl.org                        06/10/2014                 GLGETPIXELMAP(3G)
Impressum