HCoop / clinton / guile-figl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glCopyTexSubImage1D.xml
CommitLineData
7faf1d71
AW		 1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3<!-- saved from url=(0013)about:internet -->
4<?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glCopyTexSubImage1D - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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>
5 </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>
6 Specifies the target texture.
7 Must be <code class="constant">GL_TEXTURE_1D</code>.
8 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
9 Specifies the level-of-detail number.
10 Level 0 is the base image level.
11 Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
12 </p></dd><dt><span class="term"><em class="parameter"><code>xoffset</code></em></span></dt><dd><p>
13 Specifies the texel offset within the texture array.
14 </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>
15 Specify the window coordinates of the left corner
16 of the row of pixels to be copied.
17 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
18 Specifies the width of the texture subimage.
19 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
20 <code class="function">glCopyTexSubImage1D</code> replaces a portion of a one-dimensional
21 texture image with pixels from the current <code class="constant">GL_READ_BUFFER</code> (rather
22 than from main memory, as is the case for <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>).
23 </p><p>
24 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
25 length <em class="parameter"><code>width</code></em> replaces the portion of the
26 texture array with x indices <em class="parameter"><code>xoffset</code></em> through
27 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
28
29 <mml:mrow>
30 <mml:mi mathvariant="italic">xoffset</mml:mi>
31 <mml:mo>+</mml:mo>
32 <mml:mi mathvariant="italic">width</mml:mi>
33 <mml:mo>-</mml:mo>
34 <mml:mn>1</mml:mn>
35 </mml:mrow>
36 </mml:math>,
37 inclusive. The destination in the texture array may not
38 include any texels outside the texture array as it was
39 originally specified.
40 </p><p>
41 The pixels in the row are processed exactly as if
42 <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> had been called, but the process stops just before
43 final conversion.
44 At this point, all pixel component values are clamped to the range
45 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
46
47 <mml:mfenced open="[" close="]">
48 <mml:mn>0</mml:mn>
49 <mml:mn>1</mml:mn>
50 </mml:mfenced>
51 </mml:math>
52 and then converted to the texture's internal format for storage in the texel
53 array.
54 </p><p>
55 It is not an error to specify a subtexture with zero width, but
56 such a specification has no effect.
57 If any of the pixels within the specified row of the current
58 <code class="constant">GL_READ_BUFFER</code> are outside the read window associated with the current
59 rendering context, then the values obtained for those pixels are undefined.
60 </p><p>
61 No change is made to the <span class="emphasis"><em>internalformat</em></span>, <span class="emphasis"><em>width</em></span>,
62 or <span class="emphasis"><em>border</em></span> parameters of the specified texture
63 array or to texel values outside the specified subregion.
64 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
65 The <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> mode affects texture images.
66 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
67 <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>.
68 </p><p>
69 <code class="constant">GL_INVALID_OPERATION</code> is generated if the texture array has not
70 been defined by a previous <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> or <a href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a> operation.
71 </p><p>
72 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
73 </p><p>
74 <code class="constant">GL_INVALID_VALUE</code> may be generated if
75 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
76
77 <mml:mrow>
78 <mml:mi mathvariant="italic">level</mml:mi>
79 <mml:mo>&gt;</mml:mo>
80 <mml:mrow>
81 <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
82 <mml:mn>2</mml:mn>
83 </mml:msub>
84 <mml:mo>⁡</mml:mo>
85 <mml:mfenced open="(" close=")">
86 <mml:mi mathvariant="italic">max</mml:mi>
87 </mml:mfenced>
88 </mml:mrow>
89 </mml:mrow>
90 </mml:math>,
91 where <span class="emphasis"><em>max</em></span> is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
92 </p><p>
93 <code class="constant">GL_INVALID_VALUE</code> is generated if
94 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
95
96 <mml:mrow>
97 <mml:mi mathvariant="italic">xoffset</mml:mi>
98 <mml:mo>&lt;</mml:mo>
99 <mml:mrow>
100 <mml:mo>-</mml:mo>
101 <mml:mi mathvariant="italic">b</mml:mi>
102 </mml:mrow>
103 </mml:mrow>
104 </mml:math>,
105 or
106 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
107
108 <mml:mrow>
109 <mml:mfenced open="(" close=")">
110 <mml:mrow>
111 <mml:mi mathvariant="italic">xoffset</mml:mi>
112 <mml:mo>+</mml:mo>
113 <mml:mi mathvariant="italic">width</mml:mi>
114 </mml:mrow>
115 </mml:mfenced>
116 <mml:mo>&gt;</mml:mo>
117 <mml:mfenced open="(" close=")">
118 <mml:mrow>
119 <mml:mi mathvariant="italic">w</mml:mi>
120 <mml:mo>-</mml:mo>
121 <mml:mi mathvariant="italic">b</mml:mi>
122 </mml:mrow>
123 </mml:mfenced>
124 </mml:mrow>
125 </mml:math>,
126 where
127 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
128 is the <code class="constant">GL_TEXTURE_WIDTH</code> and
129 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">b</mml:mi></mml:math>
130 is the <code class="constant">GL_TEXTURE_BORDER</code>
131 of the texture image being modified.
132 Note that
133 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
134 includes twice the border width.
135 </p><p>
136 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
137 <a href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
138 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
139 <a href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
140 <a href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
141 <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
142 <a href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
143 <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
144 <a href="glReadBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</span></span></a>,
145 <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
146 <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
147 <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
148 <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>,
149 <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
150 <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
151 <a href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>
152 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
153 Copyright <span class="trademark"></span>© 1991-2006
154 Silicon Graphics, Inc. This document is licensed under the SGI
155 Free Software B License. For details, see
156 <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
157 </p></div></div></body></html>
Unnamed repository; edit this file 'description' to name the repository.