Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
2 | <!-- saved from url=(0013)about:internet --> | |
3 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>gluScaleImage</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gluScaleImage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gluScaleImage — scale an image to an arbitrary size</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">GLint <b class="fsfunc">gluScaleImage</b>(</code></td><td>GLenum </td><td><var class="pdparam">format</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">wIn</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">hIn</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">typeIn</var>, </td></tr><tr><td> </td><td>const void * </td><td><var class="pdparam">dataIn</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">wOut</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">hOut</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">typeOut</var>, </td></tr><tr><td> </td><td>GLvoid* </td><td><var class="pdparam">dataOut</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p> | |
4 | Specifies the format of the pixel data. | |
5 | The following symbolic values are valid: | |
6 | <code class="constant">GLU_COLOR_INDEX</code>, | |
7 | <code class="constant">GLU_STENCIL_INDEX</code>, | |
8 | <code class="constant">GLU_DEPTH_COMPONENT</code>, | |
9 | <code class="constant">GLU_RED</code>, | |
10 | <code class="constant">GLU_GREEN</code>, | |
11 | <code class="constant">GLU_BLUE</code>, | |
12 | <code class="constant">GLU_ALPHA</code>, | |
13 | <code class="constant">GLU_RGB</code>, | |
14 | <code class="constant">GLU_RGBA</code>, | |
15 | <code class="constant">GLU_BGR</code>, | |
16 | <code class="constant">GLU_BGRA</code>, | |
17 | <code class="constant">GLU_LUMINANCE</code>, and | |
18 | <code class="constant">GLU_LUMINANCE_ALPHA</code>. | |
19 | </p></dd><dt><span class="term"><em class="parameter"><code>wIn</code></em>, </span><span class="term"><em class="parameter"><code>hIn</code></em></span></dt><dd><p> | |
20 | Specify in pixels the width and height, respectively, of the source image. | |
21 | </p></dd><dt><span class="term"><em class="parameter"><code>typeIn</code></em></span></dt><dd><p> | |
22 | Specifies the data type for <em class="parameter"><code>dataIn</code></em>. Must be one of | |
23 | <code class="constant">GLU_UNSIGNED_BYTE</code>, | |
24 | <code class="constant">GLU_BYTE</code>, | |
25 | <code class="constant">GLU_BITMAP</code>, | |
26 | <code class="constant">GLU_UNSIGNED_SHORT</code>, | |
27 | <code class="constant">GLU_SHORT</code>, | |
28 | <code class="constant">GLU_UNSIGNED_INT</code>, | |
29 | <code class="constant">GLU_INT</code>, | |
30 | <code class="constant">GLU_FLOAT</code>, | |
31 | <code class="constant">GLU_UNSIGNED_BYTE_3_3_2</code>, | |
32 | <code class="constant">GLU_UNSIGNED_BYTE_2_3_3_REV</code>, | |
33 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5</code>, | |
34 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5_REV</code>, | |
35 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4</code>, | |
36 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4_REV</code>, | |
37 | <code class="constant">GLU_UNSIGNED_SHORT_5_5_5_1</code>, | |
38 | <code class="constant">GLU_UNSIGNED_SHORT_1_5_5_5_REV</code>, | |
39 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8</code>, | |
40 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8_REV</code>, | |
41 | <code class="constant">GLU_UNSIGNED_INT_10_10_10_2</code>, or | |
42 | <code class="constant">GLU_UNSIGNED_INT_2_10_10_10_REV</code>. | |
43 | </p></dd><dt><span class="term"><em class="parameter"><code>dataIn</code></em></span></dt><dd><p> | |
44 | Specifies a pointer to the source image. | |
45 | </p></dd><dt><span class="term"><em class="parameter"><code>wOut</code></em>, </span><span class="term"><em class="parameter"><code>hOut</code></em></span></dt><dd><p> | |
46 | Specify the width and height, respectively, in pixels of the destination image. | |
47 | </p></dd><dt><span class="term"><em class="parameter"><code>typeOut</code></em></span></dt><dd><p> | |
48 | Specifies the data type for <em class="parameter"><code>dataOut</code></em>. Must be one of | |
49 | <code class="constant">GLU_UNSIGNED_BYTE</code>, | |
50 | <code class="constant">GLU_BYTE</code>, | |
51 | <code class="constant">GLU_BITMAP</code>, | |
52 | <code class="constant">GLU_UNSIGNED_SHORT</code>, | |
53 | <code class="constant">GLU_SHORT</code>, | |
54 | <code class="constant">GLU_UNSIGNED_INT</code>, | |
55 | <code class="constant">GLU_INT</code>, | |
56 | <code class="constant">GLU_FLOAT</code>, | |
57 | <code class="constant">GLU_UNSIGNED_BYTE_3_3_2</code>, | |
58 | <code class="constant">GLU_UNSIGNED_BYTE_2_3_3_REV</code>, | |
59 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5</code>, | |
60 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5_REV</code>, | |
61 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4</code>, | |
62 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4_REV</code>, | |
63 | <code class="constant">GLU_UNSIGNED_SHORT_5_5_5_1</code>, | |
64 | <code class="constant">GLU_UNSIGNED_SHORT_1_5_5_5_REV</code>, | |
65 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8</code>, | |
66 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8_REV</code>, | |
67 | <code class="constant">GLU_UNSIGNED_INT_10_10_10_2</code>, or | |
68 | <code class="constant">GLU_UNSIGNED_INT_2_10_10_10_REV</code>. | |
69 | </p></dd><dt><span class="term"><em class="parameter"><code>dataOut</code></em></span></dt><dd><p> | |
70 | Specifies a pointer to the destination image. | |
71 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
72 | <code class="function">gluScaleImage</code> scales a pixel image using the appropriate pixel store modes to | |
73 | unpack data from the source image and pack data into the destination image. | |
74 | </p><p> | |
75 | When shrinking an image, <code class="function">gluScaleImage</code> uses a box filter to sample the source image | |
76 | and create pixels for the destination image. When magnifying an image, | |
77 | the pixels from the source image are linearly interpolated to create the | |
78 | destination image. | |
79 | </p><p> | |
80 | A return value of zero indicates success, otherwise a GLU error code is returned (see <a class="citerefentry" href="gluErrorString.xml"><span class="citerefentry"><span class="refentrytitle">gluErrorString</span></span></a>). | |
81 | </p><p> | |
82 | See the <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> reference page for a description of | |
83 | the acceptable values for the <em class="parameter"><code>format</code></em>, <em class="parameter"><code>typeIn</code></em>, and <em class="parameter"><code>typeOut</code></em> parameters. | |
84 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
85 | Formats <code class="constant">GLU_BGR</code>, and <code class="constant">GLU_BGRA</code>, and types | |
86 | <code class="constant">GLU_UNSIGNED_BYTE_3_3_2</code>, | |
87 | <code class="constant">GLU_UNSIGNED_BYTE_2_3_3_REV</code>, | |
88 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5</code>, | |
89 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5_REV</code>, | |
90 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4</code>, | |
91 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4_REV</code>, | |
92 | <code class="constant">GLU_UNSIGNED_SHORT_5_5_5_1</code>, | |
93 | <code class="constant">GLU_UNSIGNED_SHORT_1_5_5_5_REV</code>, | |
94 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8</code>, | |
95 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8_REV</code>, | |
96 | <code class="constant">GLU_UNSIGNED_INT_10_10_10_2</code>, and | |
97 | <code class="constant">GLU_UNSIGNED_INT_2_10_10_10_REV</code> are only available if the GL version | |
98 | is 1.2 or greater. | |
99 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
100 | <code class="constant">GLU_INVALID_VALUE</code> is returned if <em class="parameter"><code>wIn</code></em>, <em class="parameter"><code>hIn</code></em>, <em class="parameter"><code>wOut</code></em>, or <em class="parameter"><code>hOut</code></em> | |
101 | is negative. | |
102 | </p><p> | |
103 | <code class="constant">GLU_INVALID_ENUM</code> is returned if <em class="parameter"><code>format</code></em>, <em class="parameter"><code>typeIn</code></em>, or <em class="parameter"><code>typeOut</code></em> is not | |
104 | legal. | |
105 | </p><p> | |
106 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
107 | <code class="constant">GLU_UNSIGNED_BYTE_3_3_2</code> or <code class="constant">GLU_UNSIGNED_BYTE_2_3_3_REV</code> | |
108 | and <em class="parameter"><code>format</code></em> is not <code class="constant">GLU_RGB</code>. | |
109 | </p><p> | |
110 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
111 | <code class="constant">GLU_UNSIGNED_SHORT_5_6_5</code> or <code class="constant">GLU_UNSIGNED_SHORT_5_6_5_REV</code> | |
112 | and <em class="parameter"><code>format</code></em> is not <code class="constant">GLU_RGB</code>. | |
113 | </p><p> | |
114 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
115 | <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4</code> or <code class="constant">GLU_UNSIGNED_SHORT_4_4_4_4_REV</code> | |
116 | and <em class="parameter"><code>format</code></em> is neither <code class="constant">GLU_RGBA</code> nor <code class="constant">GLU_BGRA</code>. | |
117 | </p><p> | |
118 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
119 | <code class="constant">GLU_UNSIGNED_SHORT_5_5_5_1</code> or <code class="constant">GLU_UNSIGNED_SHORT_1_5_5_5_REV</code> | |
120 | and <em class="parameter"><code>format</code></em> is neither <code class="constant">GLU_RGBA</code> nor <code class="constant">GLU_BGRA</code>. | |
121 | </p><p> | |
122 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
123 | <code class="constant">GLU_UNSIGNED_INT_8_8_8_8</code> or <code class="constant">GLU_UNSIGNED_INT_8_8_8_8_REV</code> | |
124 | and <em class="parameter"><code>format</code></em> is neither <code class="constant">GLU_RGBA</code> nor <code class="constant">GLU_BGRA</code>. | |
125 | </p><p> | |
126 | <code class="constant">GLU_INVALID_OPERATION</code> is returned if <em class="parameter"><code>typeIn</code></em> or <em class="parameter"><code>typeOut</code></em> is | |
127 | <code class="constant">GLU_UNSIGNED_INT_10_10_10_2</code> or <code class="constant">GLU_UNSIGNED_INT_2_10_10_10_REV</code> | |
128 | and <em class="parameter"><code>format</code></em> is neither <code class="constant">GLU_RGBA</code> nor <code class="constant">GLU_BGRA</code>. | |
129 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
130 | <a class="citerefentry" href="gluBuild1DMipmaps.xml"><span class="citerefentry"><span class="refentrytitle">gluBuild1DMipmaps</span></span></a>, | |
131 | <a class="citerefentry" href="gluBuild2DMipmaps.xml"><span class="citerefentry"><span class="refentrytitle">gluBuild2DMipmaps</span></span></a>, | |
132 | <a class="citerefentry" href="gluBuild3DMipmaps.xml"><span class="citerefentry"><span class="refentrytitle">gluBuild3DMipmaps</span></span></a>, | |
133 | <a class="citerefentry" href="gluErrorString.xml"><span class="citerefentry"><span class="refentrytitle">gluErrorString</span></span></a>, | |
134 | <a class="citerefentry" href="glDrawPixels.xml"><span class="citerefentry"><span class="refentrytitle">glDrawPixels</span></span></a>, | |
135 | <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> | |
136 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
137 | Copyright <span class="trademark"></span>© 1991-2006 | |
138 | Silicon Graphics, Inc. This document is licensed under the SGI | |
139 | Free Software B License. For details, see | |
140 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
141 | </p></div></div></body></html> |