File: glGetPixelMap.3G.xml

package info (click to toggle)
pyopengl 2.0.1.08-5.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 19,484 kB
  • ctags: 9,036
  • sloc: pascal: 64,950; xml: 28,088; ansic: 20,696; python: 19,761; tcl: 668; makefile: 240; sh: 25
file content (66 lines) | stat: -rw-r--r-- 10,066 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
	xmlns="http://www.w3.org/1999/xhtml"
	xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glGetPixelMap</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glGetMinmaxParameter.3G.xml" title="glGetMinmaxParameter"/><link rel="next" href="glGetPointerv.3G.xml" title="glGetPointerv"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glGetPixelMap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glGetMinmaxParameter.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glGetPointerv.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glGetPixelMap.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glGetPixelMap.3G-name"/><h2>Name</h2><p>glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv &#8212; return the specified pixel map</p></div><div class="refsynopsisdiv"><a name="glGetPixelMap.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glGetPixelMapfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>map</tt></i>, GLfloat*<i><tt>values</tt></i>);</code></td></tr><tr><td valign="top"><code>void<tt>glGetPixelMapuiv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>map</tt></i>, GLuint*<i><tt>values</tt></i>);</code></td></tr><tr><td valign="top"><code>void<tt>glGetPixelMapusv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>map</tt></i>, GLushort*<i><tt>values</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glGetPixelMap.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glGetPixelMapfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>map</tt></i>) &#8594;<i><tt>values</tt></i></code></td></tr><tr><td valign="top"><code><tt>glGetPixelMapuiv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>map</tt></i>) &#8594;<i><tt>values</tt></i></code></td></tr><tr><td valign="top"><code><tt>glGetPixelMapusv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>map</tt></i>) &#8594;<i><tt>values</tt></i></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>map</tt></i></span></dt><dd>
						Specifies the name of the pixel map to return. Accepted values are
						<tt>GL_PIXEL_MAP_I_TO_I</tt>, <tt>GL_PIXEL_MAP_S_TO_S</tt>,
						<tt>GL_PIXEL_MAP_I_TO_R</tt>, <tt>GL_PIXEL_MAP_I_TO_G</tt>,
						<tt>GL_PIXEL_MAP_I_TO_B</tt>, <tt>GL_PIXEL_MAP_I_TO_A</tt>,
						<tt>GL_PIXEL_MAP_R_TO_R</tt>, <tt>GL_PIXEL_MAP_G_TO_G</tt>,
						<tt>GL_PIXEL_MAP_B_TO_B</tt>, and <tt>GL_PIXEL_MAP_A_TO_A</tt>.
					</dd><dt><span class="term"><i><tt>values</tt></i></span></dt><dd>
						Returns the pixel map contents.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-description"/><h2>Description</h2><p>
			See the <tt>glPixelMap</tt> reference page for a description of the acceptable values
			for the <i><tt>map</tt></i> parameter. <tt>glGetPixelMap</tt> returns in
			<i><tt>values</tt></i> the contents of the pixel map specified in <i><tt>map</tt></i>. Pixel maps are
			used during the execution of <a href="glReadPixels.3G.xml"><tt>glReadPixels</tt></a>, <a href="glDrawPixels.3G.xml"><tt>glDrawPixels</tt></a>, <a href="glCopyPixels.3G.xml"><tt>glCopyPixels</tt></a>, <a href="glTexImage1D.3G.xml"><tt>glTexImage1D</tt></a>, <a href="glTexImage2D.3G.xml"><tt>glTexImage2D</tt></a>, <a href="glTexImage3D.3G.xml"><tt>glTexImage3D</tt></a>, <a href="glTexSubImage1D.3G.xml"><tt>glTexSubImage1D</tt></a>, <a href="glTexSubImage2D.3G.xml"><tt>glTexSubImage2D</tt></a>, <a href="glTexSubImage3D.3G.xml"><tt>glTexSubImage3D</tt></a>, <a href="glCopyTexImage1D.3G.xml"><tt>glCopyTexImage1D</tt></a>, <a href="glCopyTexImage2D.3G.xml"><tt>glCopyTexImage2D</tt></a>, <a href="glCopyTexSubImage1D.3G.xml"><tt>glCopyTexSubImage1D</tt></a>, <a href="glCopyTexSubImage2D.3G.xml"><tt>glCopyTexSubImage2D</tt></a>,
			<a href="glCopyTexSubImage3D.3G.xml"><tt>glCopyTexSubImage3D</tt></a>, <a href="glColorTable.3G.xml"><tt>glColorTable</tt></a>,
			<a href="glColorSubTable.3G.xml"><tt>glColorSubTable</tt></a>, <a href="glCopyColorTable.3G.xml"><tt>glCopyColorTable</tt></a>,
			<a href="glCopyColorSubTable.3G.xml"><tt>glCopyColorSubTable</tt></a>, <a href="glConvolutionFilter1D.3G.xml"><tt>glConvolutionFilter1D</tt></a>, <a href="glConvolutionFilter2D.3G.xml"><tt>glConvolutionFilter2D</tt></a>,
			<a href="glSeparableFilter2D.3G.xml"><tt>glSeparableFilter2D</tt></a>, <a href="glGetHistogram.3G.xml"><tt>glGetHistogram</tt></a>,
			<a href="glGetMinmax.3G.xml"><tt>glGetMinmax</tt></a>, and <a href="glGetTexImage.3G.xml"><tt>glGetTexImage</tt></a> to map
			color indices, stencil indices, color components, and depth components to other values.
		</p><p>
			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].
		</p><p>
			To determine the required size of <i><tt>map</tt></i>, call <tt>glGet</tt> with
			the appropriate symbolic constant.
		</p></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-notes"/><h2>Notes</h2><p>
			If an error is generated, no change is made to the contents of <i><tt>values</tt></i>.
		</p></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>map</tt></i> is not an accepted value.
		</p><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glGetPixelMap</tt> is
			executed between the execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of
			<a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
		</p></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-associated_gets"/><h2>Associated Gets</h2><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_I_TO_I_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_S_TO_S_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_I_TO_R_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_I_TO_G_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_I_TO_B_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_I_TO_A_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_R_TO_R_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_G_TO_G_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_B_TO_B_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_PIXEL_MAP_A_TO_A_SIZE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_MAX_PIXEL_MAP_TABLE</tt>
		</p></div><div class="refsect1" lang="en"><a name="glGetPixelMap.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glColorSubTable.3G.xml">glColorSubTable</a>, <a href="glColorTable.3G.xml">glColorTable</a>, <a href="glConvolutionFilter1D.3G.xml">glConvolutionFilter1D</a>, <a href="glConvolutionFilter2D.3G.xml">glConvolutionFilter2D</a>, <a href="glCopyColorSubTable.3G.xml">glCopyColorSubTable</a>, <a href="glCopyColorTable.3G.xml">glCopyColorTable</a>, <a href="glCopyPixels.3G.xml">glCopyPixels</a>, <a href="glCopyTexImage1D.3G.xml">glCopyTexImage1D</a>, <a href="glCopyTexImage2D.3G.xml">glCopyTexImage2D</a>, <a href="glCopyTexSubImage1D.3G.xml">glCopyTexSubImage1D</a>, <a href="glCopyTexSubImage2D.3G.xml">glCopyTexSubImage2D</a>, <a href="glCopyTexSubImage3D.3G.xml">glCopyTexSubImage3D</a>, <a href="glDrawPixels.3G.xml">glDrawPixels</a>, <a href="glGetHistogram.3G.xml">glGetHistogram</a>, <a href="glGetMinmax.3G.xml">glGetMinmax</a>, <a href="glGetTexImage.3G.xml">glGetTexImage</a>, <a href="glPixelMap.3G.xml">glPixelMap</a>, <a href="glPixelTransfer.3G.xml">glPixelTransfer</a>, <a href="glReadPixels.3G.xml">glReadPixels</a>, <a href="glSeparableFilter2D.3G.xml">glSeparableFilter2D</a>, <a href="glTexImage1D.3G.xml">glTexImage1D</a>, <a href="glTexImage1D.3G.xml">glTexImage1D</a>, <a href="glTexImage2D.3G.xml"><tt>glTexImage2D</tt></a> <a href="glTexImage2D.3G.xml"><tt>glTexImage2D</tt></a>, <a href="glTexImage3D.3G.xml">glTexImage3D</a>, <a href="glTexSubImage1D.3G.xml">glTexSubImage1D</a>, <a href="glTexSubImage2D.3G.xml">glTexSubImage2D</a>, <a href="glTexSubImage3D.3G.xml">glTexSubImage3D</a></span>
		</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glGetMinmaxParameter.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glGetPointerv.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glGetMinmaxParameter</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glGetPointerv</td></tr></table></div></body></html>