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=
"glCopyTexImage1D">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glCopyTexImage1D
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glCopyTexImage1D
</refname>
17 <refpurpose>copy pixels into a
1D texture image
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glCopyTexImage1D
</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>GLint
<parameter>border
</parameter></paramdef>
33 <!-- eqn: ignoring delim $$ -->
34 <refsect1 id=
"parameters"><title>Parameters
</title>
37 <term><parameter>target
</parameter></term>
40 Specifies the target texture.
41 Must be
<constant>GL_TEXTURE_1D
</constant>.
46 <term><parameter>level
</parameter></term>
49 Specifies the level-of-detail number.
50 Level
0 is the base image level.
51 Level
<emphasis>n
</emphasis> is the
<emphasis>n
</emphasis>th mipmap reduction image.
56 <term><parameter>internalformat
</parameter></term>
59 Specifies the internal format of the texture.
60 Must be one of the following symbolic constants:
61 <constant>GL_ALPHA
</constant>,
62 <constant>GL_ALPHA4
</constant>,
63 <constant>GL_ALPHA8
</constant>,
64 <constant>GL_ALPHA12
</constant>,
65 <constant>GL_ALPHA16
</constant>,
66 <constant>GL_COMPRESSED_ALPHA
</constant>,
67 <constant>GL_COMPRESSED_LUMINANCE
</constant>,
68 <constant>GL_COMPRESSED_LUMINANCE_ALPHA
</constant>,
69 <constant>GL_COMPRESSED_INTENSITY
</constant>,
70 <constant>GL_COMPRESSED_RGB
</constant>,
71 <constant>GL_COMPRESSED_RGBA
</constant>,
72 <constant>GL_DEPTH_COMPONENT
</constant>,
73 <constant>GL_DEPTH_COMPONENT16
</constant>,
74 <constant>GL_DEPTH_COMPONENT24
</constant>,
75 <constant>GL_DEPTH_COMPONENT32
</constant>,
76 <constant>GL_LUMINANCE
</constant>,
77 <constant>GL_LUMINANCE4
</constant>,
78 <constant>GL_LUMINANCE8
</constant>,
79 <constant>GL_LUMINANCE12
</constant>,
80 <constant>GL_LUMINANCE16
</constant>,
81 <constant>GL_LUMINANCE_ALPHA
</constant>,
82 <constant>GL_LUMINANCE4_ALPHA4
</constant>,
83 <constant>GL_LUMINANCE6_ALPHA2
</constant>,
84 <constant>GL_LUMINANCE8_ALPHA8
</constant>,
85 <constant>GL_LUMINANCE12_ALPHA4
</constant>,
86 <constant>GL_LUMINANCE12_ALPHA12
</constant>,
87 <constant>GL_LUMINANCE16_ALPHA16
</constant>,
88 <constant>GL_INTENSITY
</constant>,
89 <constant>GL_INTENSITY4
</constant>,
90 <constant>GL_INTENSITY8
</constant>,
91 <constant>GL_INTENSITY12
</constant>,
92 <constant>GL_INTENSITY16
</constant>,
93 <constant>GL_RGB
</constant>,
94 <constant>GL_R3_G3_B2
</constant>,
95 <constant>GL_RGB4
</constant>,
96 <constant>GL_RGB5
</constant>,
97 <constant>GL_RGB8
</constant>,
98 <constant>GL_RGB10
</constant>,
99 <constant>GL_RGB12
</constant>,
100 <constant>GL_RGB16
</constant>,
101 <constant>GL_RGBA
</constant>,
102 <constant>GL_RGBA2
</constant>,
103 <constant>GL_RGBA4
</constant>,
104 <constant>GL_RGB5_A1
</constant>,
105 <constant>GL_RGBA8
</constant>,
106 <constant>GL_RGB10_A2
</constant>,
107 <constant>GL_RGBA12
</constant>,
108 <constant>GL_RGBA16
</constant>,
109 <constant>GL_SLUMINANCE
</constant>,
110 <constant>GL_SLUMINANCE8
</constant>,
111 <constant>GL_SLUMINANCE_ALPHA
</constant>,
112 <constant>GL_SLUMINANCE8_ALPHA8
</constant>,
113 <constant>GL_SRGB
</constant>,
114 <constant>GL_SRGB8
</constant>,
115 <constant>GL_SRGB_ALPHA
</constant>, or
116 <constant>GL_SRGB8_ALPHA8
</constant>.
121 <term><parameter>x
</parameter></term>
122 <term><parameter>y
</parameter></term>
125 Specify the window coordinates of the left corner
126 of the row of pixels to be copied.
131 <term><parameter>width
</parameter></term>
134 Specifies the width of the texture image.
136 <inlineequation><mml:math>
137 <!-- eqn: 2 sup n + 2 ( border ):-->
139 <mml:msup><mml:mn>2</mml:mn>
140 <mml:mi mathvariant=
"italic">n
</mml:mi>
145 <mml:mo>⁡</mml:mo>
146 <mml:mfenced open=
"(" close=
")">
147 <mml:mi mathvariant=
"italic">border
</mml:mi>
151 </mml:math></inlineequation>
153 <inlineequation><mml:math><mml:mi mathvariant=
"italic">n
</mml:mi></mml:math></inlineequation>.
154 The height of the texture image is
1.
159 <term><parameter>border
</parameter></term>
162 Specifies the width of the border.
163 Must be either
0 or
1.
169 <refsect1 id=
"description"><title>Description
</title>
171 <function>glCopyTexImage1D
</function> defines a one-dimensional texture image with pixels from the current
172 <constant>GL_READ_BUFFER
</constant>.
175 The screen-aligned pixel row with left corner at
176 <inlineequation><mml:math>
178 <mml:mfenced open=
"(" close=
")">
179 <mml:mi mathvariant=
"italic">x
</mml:mi>
180 <mml:mi mathvariant=
"italic">y
</mml:mi>
182 </mml:math></inlineequation>
184 <inlineequation><mml:math>
185 <!-- eqn: width + 2 ( border ):-->
187 <mml:mi mathvariant=
"italic">width
</mml:mi>
191 <mml:mo>⁡</mml:mo>
192 <mml:mfenced open=
"(" close=
")">
193 <mml:mi mathvariant=
"italic">border
</mml:mi>
197 </mml:math></inlineequation>
198 defines the texture array
199 at the mipmap level specified by
<parameter>level
</parameter>.
200 <parameter>internalformat
</parameter> specifies the internal format of the texture array.
203 The pixels in the row are processed exactly as if
204 <citerefentry><refentrytitle>glCopyPixels
</refentrytitle></citerefentry> had been called, but the process stops just before
206 At this point all pixel component values are clamped to the range
207 <inlineequation><mml:math>
209 <mml:mfenced open=
"[" close=
"]">
213 </mml:math></inlineequation>
214 and then converted to the texture's internal format for storage in the texel
218 Pixel ordering is such that lower
219 <inlineequation><mml:math><mml:mi mathvariant=
"italic">x
</mml:mi></mml:math></inlineequation>
220 screen coordinates correspond to
221 lower texture coordinates.
224 If any of the pixels within the specified row of the current
225 <constant>GL_READ_BUFFER
</constant> are outside the window associated with the current
226 rendering context, then the values obtained for those pixels are undefined.
229 <function>glCopyTexImage1D
</function> defines a one-dimensional texture image with pixels from the current
230 <constant>GL_READ_BUFFER
</constant>.
233 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.
236 <refsect1 id=
"notes"><title>Notes
</title>
238 <function>glCopyTexImage1D
</function> is available only if the GL version is
1.1 or greater.
241 Texturing has no effect in color index mode.
244 1,
2,
3, and
4 are not accepted values for
<parameter>internalformat
</parameter>.
247 An image with
0 width indicates a NULL texture.
250 When the
<code>ARB_imaging
</code> extension is supported, the RGBA components copied from the framebuffer may be processed by the imaging pipeline. See
<citerefentry><refentrytitle>glTexImage1D
</refentrytitle></citerefentry> for specific details.
253 <constant>GL_DEPTH_COMPONENT
</constant>,
<constant>GL_DEPTH_COMPONENT16
</constant>,
254 <constant>GL_DEPTH_COMPONENT24
</constant>, and
<constant>GL_DEPTH_COMPONENT32
</constant> are available only
255 if the GL version is
1.4 or greater.
258 Non-power-of-two textures are supported if the GL version is
2.0 or greater, or if the implementation exports the
<constant>GL_ARB_texture_non_power_of_two
</constant> extension.
262 <constant>GL_SRGB
</constant>,
263 <constant>GL_SRGB8
</constant>,
264 <constant>GL_SRGB_ALPHA
</constant>,
265 <constant>GL_SRGB8_ALPHA8
</constant>,
266 <constant>GL_SLUMINANCE
</constant>,
267 <constant>GL_SLUMINANCE8
</constant>,
268 <constant>GL_SLUMINANCE_ALPHA
</constant>, and
269 <constant>GL_SLUMINANCE8_ALPHA8
</constant>
270 internal formats are only available if the GL version is
2.1 or greater. See
<citerefentry><refentrytitle>glTexImage1D
</refentrytitle></citerefentry> for specific details about sRGB conversion.
273 <refsect1 id=
"errors"><title>Errors
</title>
275 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not one of the allowable values.
278 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>level
</parameter> is less than
0.
281 <constant>GL_INVALID_VALUE
</constant> may be generated if
<parameter>level
</parameter> is greater
283 <inlineequation><mml:math>
284 <!-- eqn: log sub 2 max:-->
286 <mml:msub><mml:mi mathvariant=
"italic">log
</mml:mi>
289 <mml:mo>⁢</mml:mo>
290 <mml:mi mathvariant=
"italic">max
</mml:mi>
292 </mml:math></inlineequation>,
294 <inlineequation><mml:math><mml:mi mathvariant=
"italic">max
</mml:mi></mml:math></inlineequation>
295 is the returned value of
<constant>GL_MAX_TEXTURE_SIZE
</constant>.
298 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>internalformat
</parameter> is not an allowable value.
301 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>width
</parameter> is less than
0 or greater than
302 2 +
<constant>GL_MAX_TEXTURE_SIZE
</constant>.
305 <constant>GL_INVALID_VALUE
</constant> is generated if non-power-of-two textures are not supported and the
<parameter>width
</parameter> cannot be represented as
306 <inlineequation><mml:math>
307 <!-- eqn: 2 sup n + 2 ( border ):-->
309 <mml:msup><mml:mn>2</mml:mn>
310 <mml:mi mathvariant=
"italic">n
</mml:mi>
315 <mml:mo>⁡</mml:mo>
316 <mml:mfenced open=
"(" close=
")">
317 <mml:mi mathvariant=
"italic">border
</mml:mi>
321 </mml:math></inlineequation>
322 for some integer value of
<emphasis>n
</emphasis>.
325 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>border
</parameter> is not
0 or
1.
328 <constant>GL_INVALID_OPERATION
</constant> is generated if
<function>glCopyTexImage1D
</function> is executed between the execution of
<citerefentry><refentrytitle>glBegin
</refentrytitle></citerefentry> and the corresponding execution of
<citerefentry><refentrytitle>glEnd
</refentrytitle></citerefentry>.
331 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>internalformat
</parameter> is
332 <constant>GL_DEPTH_COMPONENT
</constant>,
<constant>GL_DEPTH_COMPONENT16
</constant>,
333 <constant>GL_DEPTH_COMPONENT24
</constant>, or
<constant>GL_DEPTH_COMPONENT32
</constant> and there is no depth
337 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
339 <citerefentry><refentrytitle>glGetTexImage
</refentrytitle></citerefentry>
342 <citerefentry><refentrytitle>glIsEnabled
</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_1D
</constant>
345 <refsect1 id=
"seealso"><title>See Also
</title>
347 <citerefentry><refentrytitle>glCopyPixels
</refentrytitle></citerefentry>,
348 <citerefentry><refentrytitle>glCopyTexImage2D
</refentrytitle></citerefentry>,
349 <citerefentry><refentrytitle>glCopyTexSubImage1D
</refentrytitle></citerefentry>,
350 <citerefentry><refentrytitle>glCopyTexSubImage2D
</refentrytitle></citerefentry>,
351 <citerefentry><refentrytitle>glPixelStore
</refentrytitle></citerefentry>,
352 <citerefentry><refentrytitle>glPixelTransfer
</refentrytitle></citerefentry>,
353 <citerefentry><refentrytitle>glTexEnv
</refentrytitle></citerefentry>,
354 <citerefentry><refentrytitle>glTexGen
</refentrytitle></citerefentry>,
355 <citerefentry><refentrytitle>glTexImage1D
</refentrytitle></citerefentry>,
356 <citerefentry><refentrytitle>glTexImage2D
</refentrytitle></citerefentry>,
357 <citerefentry><refentrytitle>glTexSubImage1D
</refentrytitle></citerefentry>,
358 <citerefentry><refentrytitle>glTexSubImage2D
</refentrytitle></citerefentry>,
359 <citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>
362 <refsect1 id=
"Copyright"><title>Copyright
</title>
364 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
365 Silicon Graphics, Inc. This document is licensed under the SGI
366 Free Software B License. For details, see
367 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.