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>glCopyTexSubImage1D
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><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 border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><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>
4 </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>
5 Specifies the target texture.
6 Must be
<code class=
"constant">GL_TEXTURE_1D
</code>.
7 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>level
</code></em></span></dt><dd><p>
8 Specifies the level-of-detail number.
9 Level
0 is the base image level.
10 Level
<span class=
"emphasis"><em>n
</em></span> is the
<span class=
"emphasis"><em>n
</em></span>th mipmap reduction image.
11 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>xoffset
</code></em></span></dt><dd><p>
12 Specifies the texel offset within the texture array.
13 </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>
14 Specify the window coordinates of the left corner
15 of the row of pixels to be copied.
16 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>width
</code></em></span></dt><dd><p>
17 Specifies the width of the texture subimage.
18 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
19 <code class=
"function">glCopyTexSubImage1D
</code> replaces a portion of a one-dimensional
20 texture image with pixels from the current
<code class=
"constant">GL_READ_BUFFER
</code> (rather
21 than from main memory, as is the case for
<a class=
"citerefentry" href=
"glTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage1D
</span></span></a>).
23 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
24 length
<em class=
"parameter"><code>width
</code></em> replaces the portion of the
25 texture array with x indices
<em class=
"parameter"><code>xoffset
</code></em> through
26 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
29 <mml:mi mathvariant=
"italic">xoffset
</mml:mi>
31 <mml:mi mathvariant=
"italic">width
</mml:mi>
36 inclusive. The destination in the texture array may not
37 include any texels outside the texture array as it was
40 The pixels in the row are processed exactly as if
41 <a class=
"citerefentry" href=
"glCopyPixels.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyPixels
</span></span></a> had been called, but the process stops just before
43 At this point, all pixel component values are clamped to the range
44 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
46 <mml:mfenced open=
"[" close=
"]">
51 and then converted to the texture's internal format for storage in the texel
54 It is not an error to specify a subtexture with zero width, but
55 such a specification has no effect.
56 If any of the pixels within the specified row of the current
57 <code class=
"constant">GL_READ_BUFFER
</code> are outside the read window associated with the current
58 rendering context, then the values obtained for those pixels are undefined.
60 No change is made to the
<span class=
"emphasis"><em>internalformat
</em></span>,
<span class=
"emphasis"><em>width
</em></span>,
61 or
<span class=
"emphasis"><em>border
</em></span> parameters of the specified texture
62 array or to texel values outside the specified subregion.
63 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
64 <code class=
"function">glCopyTexSubImage1D
</code> is available only if the GL version is
1.1 or greater.
66 Texturing has no effect in color index mode.
68 <a class=
"citerefentry" href=
"glPixelStore.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelStore
</span></span></a> and
<a class=
"citerefentry" href=
"glPixelTransfer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelTransfer
</span></span></a> modes affect texture images
69 in exactly the way they affect
<a class=
"citerefentry" href=
"glDrawPixels.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawPixels
</span></span></a>.
71 When the
<code class=
"code">ARB_imaging
</code> extension is supported, the RGBA components
72 copied from the framebuffer may be processed by the imaging pipeline. See
73 <a class=
"citerefentry" href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a> for specific details.
74 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
75 <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>.
77 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if the texture array has not
78 been defined by a previous
<a class=
"citerefentry" href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a> or
<a class=
"citerefentry" href=
"glCopyTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage1D
</span></span></a> operation.
80 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>level
</code></em> is less than
0.
82 <code class=
"constant">GL_INVALID_VALUE
</code> may be generated if
83 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
86 <mml:mi mathvariant=
"italic">level
</mml:mi>
89 <mml:msub><mml:mi mathvariant=
"italic">log
</mml:mi>
93 <mml:mfenced open=
"(" close=
")">
94 <mml:mi mathvariant=
"italic">max
</mml:mi>
99 where
<span class=
"emphasis"><em>max
</em></span> is the returned value of
<code class=
"constant">GL_MAX_TEXTURE_SIZE
</code>.
101 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
102 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
105 <mml:mi mathvariant=
"italic">xoffset
</mml:mi>
106 <mml:mo><</mml:mo>
109 <mml:mi mathvariant=
"italic">b
</mml:mi>
114 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
117 <mml:mfenced open=
"(" close=
")">
119 <mml:mi mathvariant=
"italic">xoffset
</mml:mi>
121 <mml:mi mathvariant=
"italic">width
</mml:mi>
124 <mml:mo>></mml:mo>
125 <mml:mfenced open=
"(" close=
")">
127 <mml:mi mathvariant=
"italic">w
</mml:mi>
129 <mml:mi mathvariant=
"italic">b
</mml:mi>
135 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">w
</mml:mi></mml:math>
136 is the
<code class=
"constant">GL_TEXTURE_WIDTH
</code> and
137 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">b
</mml:mi></mml:math>
138 is the
<code class=
"constant">GL_TEXTURE_BORDER
</code>
139 of the texture image being modified.
141 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">w
</mml:mi></mml:math>
142 includes twice the border width.
144 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
145 <a class=
"citerefentry" href=
"glGetTexImage.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetTexImage
</span></span></a>
147 <a class=
"citerefentry" href=
"glIsEnabled.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIsEnabled
</span></span></a> with argument
<code class=
"constant">GL_TEXTURE_1D
</code>
148 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
149 <a class=
"citerefentry" href=
"glCopyPixels.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyPixels
</span></span></a>,
150 <a class=
"citerefentry" href=
"glCopyTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage1D
</span></span></a>,
151 <a class=
"citerefentry" href=
"glCopyTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage2D
</span></span></a>,
152 <a class=
"citerefentry" href=
"glCopyTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage2D
</span></span></a>,
153 <a class=
"citerefentry" href=
"glCopyTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage3D
</span></span></a>,
154 <a class=
"citerefentry" href=
"glPixelStore.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelStore
</span></span></a>,
155 <a class=
"citerefentry" href=
"glPixelTransfer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelTransfer
</span></span></a>,
156 <a class=
"citerefentry" href=
"glReadBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glReadBuffer
</span></span></a>,
157 <a class=
"citerefentry" href=
"glTexEnv.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexEnv
</span></span></a>,
158 <a class=
"citerefentry" href=
"glTexGen.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexGen
</span></span></a>,
159 <a class=
"citerefentry" href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a>,
160 <a class=
"citerefentry" href=
"glTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage2D
</span></span></a>,
161 <a class=
"citerefentry" href=
"glTexImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage3D
</span></span></a>,
162 <a class=
"citerefentry" href=
"glTexParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexParameter
</span></span></a>,
163 <a class=
"citerefentry" href=
"glTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage1D
</span></span></a>,
164 <a class=
"citerefentry" href=
"glTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage2D
</span></span></a>,
165 <a class=
"citerefentry" href=
"glTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage3D
</span></span></a>
166 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
167 Copyright
<span class=
"trademark"></span>©
1991-
2006
168 Silicon Graphics, Inc. This document is licensed under the SGI
169 Free Software B License. For details, see
170 <a class=
"ulink" href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
171 </p></div></div></body></html>