-
Notifications
You must be signed in to change notification settings - Fork 94
/
glCopyTexSubImage1D.xhtml
171 lines (166 loc) · 12.9 KB
/
glCopyTexSubImage1D.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
<div class="refentry" lang="en" xml:lang="en"><a id="glCopyTexSubImage1D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyTexSubImage1D — copy a one-dimensional texture subimage</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glCopyTexSubImage1D</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>GLint </td><td><var class="pdparam">xoffset</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><code>)</code>;</td></tr></table></div></div><p>
</p><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>xoffset</code></em></span></dt><dd><p>
Specifies the texel offset within the texture array.
</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 subimage.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glCopyTexSubImage1D</code> replaces a portion of a one-dimensional
texture image with pixels from the current <code class="constant">GL_READ_BUFFER</code> (rather
than from main memory, as is the case for <a class="citerefentry" href="glTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>).
</p><p>
The screen-aligned pixel row with left corner at (<em class="parameter"><code>x</code></em>,\ <em class="parameter"><code>y</code></em>), and with
length <em class="parameter"><code>width</code></em> replaces the portion of the
texture array with x indices <em class="parameter"><code>xoffset</code></em> through
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">width</mi>
<mo>-</mo>
<mn>1</mn>
</mrow>
</math>,
inclusive. The destination in the texture array may not
include any texels outside the texture array as it was
originally specified.
</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>
It is not an error to specify a subtexture with zero width, but
such a specification has no effect.
If any of the pixels within the specified row of the current
<code class="constant">GL_READ_BUFFER</code> are outside the read window associated with the current
rendering context, then the values obtained for those pixels are undefined.
</p><p>
No change is made to the <span class="emphasis"><em>internalformat</em></span>, <span class="emphasis"><em>width</em></span>,
or <span class="emphasis"><em>border</em></span> parameters of the specified texture
array or to texel values outside the specified subregion.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glCopyTexSubImage1D</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>
<a class="citerefentry" href="glPixelStore"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> and <a class="citerefentry" href="glPixelTransfer"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a> modes affect texture images
in exactly the way they affect <a class="citerefentry" href="glDrawPixels"><span class="citerefentry"><span class="refentrytitle">glDrawPixels</span></span></a>.
</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></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 <code class="constant">GL_TEXTURE_1D</code>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the texture array has not
been defined by a previous <a class="citerefentry" href="glTexImage1D"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> or <a class="citerefentry" href="glCopyTexImage1D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a> operation.
</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
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">level</mi>
<mo>></mo>
<mrow>
<msub><mi mathvariant="italic">log</mi>
<mn>2</mn>
</msub>
<mo></mo>
<mfenced open="(" close=")">
<mi mathvariant="italic">max</mi>
</mfenced>
</mrow>
</mrow>
</math>,
where <span class="emphasis"><em>max</em></span> 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
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo><</mo>
<mrow>
<mo>-</mo>
<mi mathvariant="italic">b</mi>
</mrow>
</mrow>
</math>,
or
<math overflow="scroll">
<mrow>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">width</mi>
</mrow>
</mfenced>
<mo>></mo>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">w</mi>
<mo>-</mo>
<mi mathvariant="italic">b</mi>
</mrow>
</mfenced>
</mrow>
</math>,
where
<math overflow="scroll"><mi mathvariant="italic">w</mi></math>
is the <code class="constant">GL_TEXTURE_WIDTH</code> and
<math overflow="scroll"><mi mathvariant="italic">b</mi></math>
is the <code class="constant">GL_TEXTURE_BORDER</code>
of the texture image being modified.
Note that
<math overflow="scroll"><mi mathvariant="italic">w</mi></math>
includes twice the border width.
</p><p>
</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="glCopyTexImage1D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
<a class="citerefentry" href="glCopyTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</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="glReadBuffer"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</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="glTexImage3D"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
<a class="citerefentry" href="glTexParameter"><span class="citerefentry"><span class="refentrytitle">glTexParameter</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="glTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</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>