/
glCopyTexImage1D.xhtml
258 lines (252 loc) · 18.2 KB
/
glCopyTexImage1D.xhtml
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<div class="refentry" lang="en" xml:lang="en"><a id="glCopyTexImage1D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyTexImage1D — copy pixels into a 1D texture image</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glCopyTexImage1D</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">internalformat</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">border</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>target</code></em></span></dt><dd><p>
Specifies the target texture.
Must be <code class="constant">GL_TEXTURE_1D</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
Specifies the level-of-detail number.
Level 0 is the base image level.
Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
</p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p>
Specifies the internal format of the texture.
Must be one of the following symbolic constants:
<code class="constant">GL_ALPHA</code>,
<code class="constant">GL_ALPHA4</code>,
<code class="constant">GL_ALPHA8</code>,
<code class="constant">GL_ALPHA12</code>,
<code class="constant">GL_ALPHA16</code>,
<code class="constant">GL_COMPRESSED_ALPHA</code>,
<code class="constant">GL_COMPRESSED_LUMINANCE</code>,
<code class="constant">GL_COMPRESSED_LUMINANCE_ALPHA</code>,
<code class="constant">GL_COMPRESSED_INTENSITY</code>,
<code class="constant">GL_COMPRESSED_RGB</code>,
<code class="constant">GL_COMPRESSED_RGBA</code>,
<code class="constant">GL_DEPTH_COMPONENT</code>,
<code class="constant">GL_DEPTH_COMPONENT16</code>,
<code class="constant">GL_DEPTH_COMPONENT24</code>,
<code class="constant">GL_DEPTH_COMPONENT32</code>,
<code class="constant">GL_LUMINANCE</code>,
<code class="constant">GL_LUMINANCE4</code>,
<code class="constant">GL_LUMINANCE8</code>,
<code class="constant">GL_LUMINANCE12</code>,
<code class="constant">GL_LUMINANCE16</code>,
<code class="constant">GL_LUMINANCE_ALPHA</code>,
<code class="constant">GL_LUMINANCE4_ALPHA4</code>,
<code class="constant">GL_LUMINANCE6_ALPHA2</code>,
<code class="constant">GL_LUMINANCE8_ALPHA8</code>,
<code class="constant">GL_LUMINANCE12_ALPHA4</code>,
<code class="constant">GL_LUMINANCE12_ALPHA12</code>,
<code class="constant">GL_LUMINANCE16_ALPHA16</code>,
<code class="constant">GL_INTENSITY</code>,
<code class="constant">GL_INTENSITY4</code>,
<code class="constant">GL_INTENSITY8</code>,
<code class="constant">GL_INTENSITY12</code>,
<code class="constant">GL_INTENSITY16</code>,
<code class="constant">GL_RGB</code>,
<code class="constant">GL_R3_G3_B2</code>,
<code class="constant">GL_RGB4</code>,
<code class="constant">GL_RGB5</code>,
<code class="constant">GL_RGB8</code>,
<code class="constant">GL_RGB10</code>,
<code class="constant">GL_RGB12</code>,
<code class="constant">GL_RGB16</code>,
<code class="constant">GL_RGBA</code>,
<code class="constant">GL_RGBA2</code>,
<code class="constant">GL_RGBA4</code>,
<code class="constant">GL_RGB5_A1</code>,
<code class="constant">GL_RGBA8</code>,
<code class="constant">GL_RGB10_A2</code>,
<code class="constant">GL_RGBA12</code>,
<code class="constant">GL_RGBA16</code>,
<code class="constant">GL_SLUMINANCE</code>,
<code class="constant">GL_SLUMINANCE8</code>,
<code class="constant">GL_SLUMINANCE_ALPHA</code>,
<code class="constant">GL_SLUMINANCE8_ALPHA8</code>,
<code class="constant">GL_SRGB</code>,
<code class="constant">GL_SRGB8</code>,
<code class="constant">GL_SRGB_ALPHA</code>, or
<code class="constant">GL_SRGB8_ALPHA8</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>x</code></em>, </span><span class="term"><em class="parameter"><code>y</code></em></span></dt><dd><p>
Specify the window coordinates of the left corner
of the row of pixels to be copied.
</p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
Specifies the width of the texture image.
Must be 0 or
<math overflow="scroll">
<mrow>
<msup><mn>2</mn>
<mi mathvariant="italic">n</mi>
</msup>
<mo>+</mo>
<mrow>
<mn>2</mn>
<mo></mo>
<mfenced open="(" close=")">
<mi mathvariant="italic">border</mi>
</mfenced>
</mrow>
</mrow>
</math>
for some integer
<math overflow="scroll"><mi mathvariant="italic">n</mi></math>.
The height of the texture image is 1.
</p></dd><dt><span class="term"><em class="parameter"><code>border</code></em></span></dt><dd><p>
Specifies the width of the border.
Must be either 0 or 1.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current
<code class="constant">GL_READ_BUFFER</code>.
</p><p>
The screen-aligned pixel row with left corner at
<math overflow="scroll">
<mfenced open="(" close=")">
<mi mathvariant="italic">x</mi>
<mi mathvariant="italic">y</mi>
</mfenced>
</math>
and with a length of
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">width</mi>
<mo>+</mo>
<mrow>
<mn>2</mn>
<mo></mo>
<mfenced open="(" close=")">
<mi mathvariant="italic">border</mi>
</mfenced>
</mrow>
</mrow>
</math>
defines the texture array
at the mipmap level specified by <em class="parameter"><code>level</code></em>.
<em class="parameter"><code>internalformat</code></em> specifies the internal format of the texture array.
</p><p>
The pixels in the row are processed exactly as if
<a class="citerefentry" href="glCopyPixels"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a> had been called, but the process stops just before
final conversion.
At this point all pixel component values are clamped to the range
<math overflow="scroll">
<mfenced open="[" close="]">
<mn>0</mn>
<mn>1</mn>
</mfenced>
</math>
and then converted to the texture's internal format for storage in the texel
array.
</p><p>
Pixel ordering is such that lower
<math overflow="scroll"><mi mathvariant="italic">x</mi></math>
screen coordinates correspond to
lower texture coordinates.
</p><p>
If any of the pixels within the specified row of the current
<code class="constant">GL_READ_BUFFER</code> are outside the window associated with the current
rendering context, then the values obtained for those pixels are undefined.
</p><p>
<code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current
<code class="constant">GL_READ_BUFFER</code>.
</p><p>
When <em class="parameter"><code>internalformat</code></em> is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the <code class="function">glPixelMap</code> function can be used to accomplish the conversion.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glCopyTexImage1D</code> is available only if the GL version is 1.1 or greater.
</p><p>
Texturing has no effect in color index mode.
</p><p>
1, 2, 3, and 4 are not accepted values for <em class="parameter"><code>internalformat</code></em>.
</p><p>
An image with 0 width indicates a NULL texture.
</p><p>
When the <code class="code">ARB_imaging</code> extension is supported, the RGBA components copied from the framebuffer may be processed by the imaging pipeline. See <a class="citerefentry" href="glTexImage1D"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> for specific details.
</p><p>
<code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>,
<code class="constant">GL_DEPTH_COMPONENT24</code>, and <code class="constant">GL_DEPTH_COMPONENT32</code> are available only
if the GL version is 1.4 or greater.
</p><p>
Non-power-of-two textures are supported if the GL version is 2.0 or greater, or if the implementation exports the <code class="constant">GL_ARB_texture_non_power_of_two</code> extension.
</p><p>
The
<code class="constant">GL_SRGB</code>,
<code class="constant">GL_SRGB8</code>,
<code class="constant">GL_SRGB_ALPHA</code>,
<code class="constant">GL_SRGB8_ALPHA8</code>,
<code class="constant">GL_SLUMINANCE</code>,
<code class="constant">GL_SLUMINANCE8</code>,
<code class="constant">GL_SLUMINANCE_ALPHA</code>, and
<code class="constant">GL_SLUMINANCE8_ALPHA8</code>
internal formats are only available if the GL version is 2.1 or greater. See <a class="citerefentry" href="glTexImage1D"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> for specific details about sRGB conversion.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable values.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> may be generated if <em class="parameter"><code>level</code></em> is greater
than
<math overflow="scroll">
<mrow>
<msub><mi mathvariant="italic">log</mi>
<mn>2</mn>
</msub>
<mo></mo>
<mi mathvariant="italic">max</mi>
</mrow>
</math>,
where
<math overflow="scroll"><mi mathvariant="italic">max</mi></math>
is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>internalformat</code></em> is not an allowable value.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>width</code></em> is less than 0 or greater than
2 + <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if non-power-of-two textures are not supported and the <em class="parameter"><code>width</code></em> cannot be represented as
<math overflow="scroll">
<mrow>
<msup><mn>2</mn>
<mi mathvariant="italic">n</mi>
</msup>
<mo>+</mo>
<mrow>
<mn>2</mn>
<mo></mo>
<mfenced open="(" close=")">
<mi mathvariant="italic">border</mi>
</mfenced>
</mrow>
</mrow>
</math>
for some integer value of <span class="emphasis"><em>n</em></span>.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0 or 1.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCopyTexImage1D</code> is executed between the execution of <a class="citerefentry" href="glBegin"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>internalformat</code></em> is
<code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>,
<code class="constant">GL_DEPTH_COMPONENT24</code>, or <code class="constant">GL_DEPTH_COMPONENT32</code> and there is no depth
buffer.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGetTexImage"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
</p><p>
<a class="citerefentry" href="glIsEnabled"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_TEXTURE_1D</code>
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glCopyPixels"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>,
<a class="citerefentry" href="glCopyTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glPixelStore"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
<a class="citerefentry" href="glPixelTransfer"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>,
<a class="citerefentry" href="glTexEnv"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>,
<a class="citerefentry" href="glTexGen"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>,
<a class="citerefentry" href="glTexImage1D"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
<a class="citerefentry" href="glTexImage2D"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
<a class="citerefentry" href="glTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
<a class="citerefentry" href="glTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glTexParameter"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></div>