1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glCopyTexImage2D">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glCopyTexImage2D
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glCopyTexImage2D
</refname>
17 <refpurpose>copy pixels into a
2D texture image
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glCopyTexImage2D
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLint
<parameter>level
</parameter></paramdef>
25 <paramdef>GLenum
<parameter>internalformat
</parameter></paramdef>
26 <paramdef>GLint
<parameter>x
</parameter></paramdef>
27 <paramdef>GLint
<parameter>y
</parameter></paramdef>
28 <paramdef>GLsizei
<parameter>width
</parameter></paramdef>
29 <paramdef>GLsizei
<parameter>height
</parameter></paramdef>
30 <paramdef>GLint
<parameter>border
</parameter></paramdef>
34 <!-- eqn: ignoring delim $$ -->
35 <refsect1 id=
"parameters"><title>Parameters
</title>
38 <term><parameter>target
</parameter></term>
41 Specifies the target texture.
42 Must be
<constant>GL_TEXTURE_2D
</constant>,
43 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X
</constant>,
44 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X
</constant>,
45 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y
</constant>,
46 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
</constant>,
47 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z
</constant>, or
48 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
</constant>.
53 <term><parameter>level
</parameter></term>
56 Specifies the level-of-detail number.
57 Level
0 is the base image level.
58 Level
<emphasis>n
</emphasis> is the
<emphasis>n
</emphasis>th mipmap reduction image.
63 <term><parameter>internalformat
</parameter></term>
66 Specifies the internal format of the texture.
67 Must be one of the following symbolic constants:
68 <constant>GL_COMPRESSED_RED
</constant>,
69 <constant>GL_COMPRESSED_RG
</constant>,
70 <constant>GL_COMPRESSED_RGB
</constant>,
71 <constant>GL_COMPRESSED_RGBA
</constant>.
72 <constant>GL_COMPRESSED_SRGB
</constant>,
73 <constant>GL_COMPRESSED_SRGB_ALPHA
</constant>.
74 <constant>GL_DEPTH_COMPONENT
</constant>,
75 <constant>GL_DEPTH_COMPONENT16
</constant>,
76 <constant>GL_DEPTH_COMPONENT24
</constant>,
77 <constant>GL_DEPTH_COMPONENT32
</constant>,
78 <constant>GL_RED
</constant>,
79 <constant>GL_RG
</constant>,
80 <constant>GL_RGB
</constant>,
81 <constant>GL_R3_G3_B2
</constant>,
82 <constant>GL_RGB4
</constant>,
83 <constant>GL_RGB5
</constant>,
84 <constant>GL_RGB8
</constant>,
85 <constant>GL_RGB10
</constant>,
86 <constant>GL_RGB12
</constant>,
87 <constant>GL_RGB16
</constant>,
88 <constant>GL_RGBA
</constant>,
89 <constant>GL_RGBA2
</constant>,
90 <constant>GL_RGBA4
</constant>,
91 <constant>GL_RGB5_A1
</constant>,
92 <constant>GL_RGBA8
</constant>,
93 <constant>GL_RGB10_A2
</constant>,
94 <constant>GL_RGBA12
</constant>,
95 <constant>GL_RGBA16
</constant>,
96 <constant>GL_SRGB
</constant>,
97 <constant>GL_SRGB8
</constant>,
98 <constant>GL_SRGB_ALPHA
</constant>, or
99 <constant>GL_SRGB8_ALPHA8
</constant>.
104 <term><parameter>x
</parameter></term>
105 <term><parameter>y
</parameter></term>
108 Specify the window coordinates of the lower left corner
109 of the rectangular region of pixels to be copied.
114 <term><parameter>width
</parameter></term>
117 Specifies the width of the texture image.
119 <inlineequation><mml:math>
120 <!-- eqn: 2 sup n + 2 ( border ): -->
122 <mml:msup><mml:mn>2</mml:mn>
123 <mml:mi mathvariant=
"italic">n
</mml:mi>
128 <mml:mo>⁡</mml:mo>
129 <mml:mfenced open=
"(" close=
")">
130 <mml:mi mathvariant=
"italic">border
</mml:mi>
134 </mml:math></inlineequation>
136 <inlineequation><mml:math><mml:mi mathvariant=
"italic">n
</mml:mi></mml:math></inlineequation>.
141 <term><parameter>height
</parameter></term>
144 Specifies the height of the texture image.
146 <inlineequation><mml:math>
147 <!-- eqn: 2 sup m + 2 ( border ): -->
149 <mml:msup><mml:mn>2</mml:mn>
150 <mml:mi mathvariant=
"italic">m
</mml:mi>
155 <mml:mo>⁡</mml:mo>
156 <mml:mfenced open=
"(" close=
")">
157 <mml:mi mathvariant=
"italic">border
</mml:mi>
161 </mml:math></inlineequation>
163 <inlineequation><mml:math><mml:mi mathvariant=
"italic">m
</mml:mi></mml:math></inlineequation>.
168 <term><parameter>border
</parameter></term>
171 Specifies the width of the border.
172 Must be either
0 or
1.
178 <refsect1 id=
"description"><title>Description
</title>
180 <function>glCopyTexImage2D
</function> defines a two-dimensional texture image, or cube-map texture image
181 with pixels from the current
182 <constant>GL_READ_BUFFER
</constant>.
185 The screen-aligned pixel rectangle with lower left corner at (
<parameter>x
</parameter>,
186 <parameter>y
</parameter>) and with a width of
187 <inlineequation><mml:math>
188 <!-- eqn: width + 2 ( border ): -->
190 <mml:mi mathvariant=
"italic">width
</mml:mi>
194 <mml:mo>⁡</mml:mo>
195 <mml:mfenced open=
"(" close=
")">
196 <mml:mi mathvariant=
"italic">border
</mml:mi>
200 </mml:math></inlineequation>
202 <inlineequation><mml:math>
203 <!-- eqn: height + 2 ( border ): -->
205 <mml:mi mathvariant=
"italic">height
</mml:mi>
209 <mml:mo>⁡</mml:mo>
210 <mml:mfenced open=
"(" close=
")">
211 <mml:mi mathvariant=
"italic">border
</mml:mi>
215 </mml:math></inlineequation>
216 defines the texture array
217 at the mipmap level specified by
<parameter>level
</parameter>.
218 <parameter>internalformat
</parameter> specifies the internal format of the texture array.
221 The pixels in the rectangle are processed exactly as if
222 <citerefentry><refentrytitle>glReadPixels
</refentrytitle></citerefentry> had been called, but the process stops just before
224 At this point all pixel component values are clamped to the range
225 <inlineequation><mml:math>
227 <mml:mfenced open=
"[" close=
"]">
231 </mml:math></inlineequation>
232 and then converted to the texture's internal format for storage in the texel
236 Pixel ordering is such that lower
237 <inlineequation><mml:math><mml:mi mathvariant=
"italic">x
</mml:mi></mml:math></inlineequation>
239 <inlineequation><mml:math><mml:mi mathvariant=
"italic">y
</mml:mi></mml:math></inlineequation>
240 screen coordinates correspond to
242 <inlineequation><mml:math><mml:mi mathvariant=
"italic">s
</mml:mi></mml:math></inlineequation>
244 <inlineequation><mml:math><mml:mi mathvariant=
"italic">t
</mml:mi></mml:math></inlineequation>
248 If any of the pixels within the specified rectangle of the current
249 <constant>GL_READ_BUFFER
</constant> are outside the window associated with the current
250 rendering context, then the values obtained for those pixels are undefined.
253 When
<parameter>internalformat
</parameter> is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the
<function>glPixelMap
</function> function can be used to accomplish the conversion.
256 <refsect1 id=
"notes"><title>Notes
</title>
258 1,
2,
3, and
4 are not accepted values for
<parameter>internalformat
</parameter>.
261 An image with height or width of
0 indicates a NULL texture.
264 <refsect1 id=
"errors"><title>Errors
</title>
266 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not
<constant>GL_TEXTURE_2D
</constant>,
267 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X
</constant>,
268 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X
</constant>,
269 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y
</constant>,
270 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
</constant>,
271 <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z
</constant>, or
272 <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
</constant>.
275 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>level
</parameter> is less than
0.
278 <constant>GL_INVALID_VALUE
</constant> may be generated if
<parameter>level
</parameter> is greater
280 <inlineequation><mml:math>
281 <!-- eqn: log sub 2 max: -->
283 <mml:msub><mml:mi mathvariant=
"italic">log
</mml:mi>
286 <mml:mo>⁢</mml:mo>
287 <mml:mi mathvariant=
"italic">max
</mml:mi>
289 </mml:math></inlineequation>,
291 <inlineequation><mml:math><mml:mi mathvariant=
"italic">max
</mml:mi></mml:math></inlineequation>
292 is the returned value of
<constant>GL_MAX_TEXTURE_SIZE
</constant>.
295 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>width
</parameter> is less than
0
297 <constant>GL_MAX_TEXTURE_SIZE
</constant>.
300 <constant>GL_INVALID_VALUE
</constant> is generated if non-power-of-two textures are not supported and the
<parameter>width
</parameter> or
<parameter>depth
</parameter> cannot be represented as
301 <inlineequation><mml:math>
302 <!-- eqn: 2 sup k + 2 ( border ): -->
304 <mml:msup><mml:mn>2</mml:mn>
305 <mml:mi mathvariant=
"italic">k
</mml:mi>
310 <mml:mo>⁡</mml:mo>
311 <mml:mfenced open=
"(" close=
")">
312 <mml:mi mathvariant=
"italic">border
</mml:mi>
316 </mml:math></inlineequation>
318 <inlineequation><mml:math><mml:mi mathvariant=
"italic">k
</mml:mi></mml:math></inlineequation>.
321 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>border
</parameter> is not
0 or
1.
324 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>internalformat
</parameter> is not an
328 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>internalformat
</parameter> is
329 <constant>GL_DEPTH_COMPONENT
</constant>,
<constant>GL_DEPTH_COMPONENT16
</constant>,
330 <constant>GL_DEPTH_COMPONENT24
</constant>, or
<constant>GL_DEPTH_COMPONENT32
</constant> and there is no depth
334 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
336 <citerefentry><refentrytitle>glGetTexImage
</refentrytitle></citerefentry>
339 <refsect1 id=
"seealso"><title>See Also
</title>
341 <citerefentry><refentrytitle>glCopyTexImage1D
</refentrytitle></citerefentry>,
342 <citerefentry><refentrytitle>glCopyTexSubImage1D
</refentrytitle></citerefentry>,
343 <citerefentry><refentrytitle>glCopyTexSubImage2D
</refentrytitle></citerefentry>,
344 <citerefentry><refentrytitle>glPixelStore
</refentrytitle></citerefentry>,
345 <citerefentry><refentrytitle>glTexImage1D
</refentrytitle></citerefentry>,
346 <citerefentry><refentrytitle>glTexImage2D
</refentrytitle></citerefentry>,
347 <citerefentry><refentrytitle>glTexSubImage1D
</refentrytitle></citerefentry>,
348 <citerefentry><refentrytitle>glTexSubImage2D
</refentrytitle></citerefentry>,
349 <citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>
352 <refsect1 id=
"Copyright"><title>Copyright
</title>
354 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
355 Silicon Graphics, Inc. This document is licensed under the SGI
356 Free Software B License. For details, see
357 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.