--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
+<!-- saved from url=(0013)about:internet -->
+<?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>
+ </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.xml"><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
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:mrow>
+ <mml:mi mathvariant="italic">xoffset</mml:mi>
+ <mml:mo>+</mml:mo>
+ <mml:mi mathvariant="italic">width</mml:mi>
+ <mml:mo>-</mml:mo>
+ <mml:mn>1</mml:mn>
+ </mml:mrow>
+ </mml: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.xml"><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
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:mfenced open="[" close="]">
+ <mml:mn>0</mml:mn>
+ <mml:mn>1</mml:mn>
+ </mml:mfenced>
+ </mml: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.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
+ in exactly the way they affect <a class="citerefentry" href="glDrawPixels.xml"><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.xml"><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.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.
+ </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
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:mrow>
+ <mml:mi mathvariant="italic">level</mml:mi>
+ <mml:mo>></mml:mo>
+ <mml:mrow>
+ <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
+ <mml:mn>2</mml:mn>
+ </mml:msub>
+ <mml:mo></mml:mo>
+ <mml:mfenced open="(" close=")">
+ <mml:mi mathvariant="italic">max</mml:mi>
+ </mml:mfenced>
+ </mml:mrow>
+ </mml:mrow>
+ </mml: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
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:mrow>
+ <mml:mi mathvariant="italic">xoffset</mml:mi>
+ <mml:mo><</mml:mo>
+ <mml:mrow>
+ <mml:mo>-</mml:mo>
+ <mml:mi mathvariant="italic">b</mml:mi>
+ </mml:mrow>
+ </mml:mrow>
+ </mml:math>,
+ or
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:mrow>
+ <mml:mfenced open="(" close=")">
+ <mml:mrow>
+ <mml:mi mathvariant="italic">xoffset</mml:mi>
+ <mml:mo>+</mml:mo>
+ <mml:mi mathvariant="italic">width</mml:mi>
+ </mml:mrow>
+ </mml:mfenced>
+ <mml:mo>></mml:mo>
+ <mml:mfenced open="(" close=")">
+ <mml:mrow>
+ <mml:mi mathvariant="italic">w</mml:mi>
+ <mml:mo>-</mml:mo>
+ <mml:mi mathvariant="italic">b</mml:mi>
+ </mml:mrow>
+ </mml:mfenced>
+ </mml:mrow>
+ </mml:math>,
+ where
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
+ is the <code class="constant">GL_TEXTURE_WIDTH</code> and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">b</mml:mi></mml:math>
+ is the <code class="constant">GL_TEXTURE_BORDER</code>
+ of the texture image being modified.
+ Note that
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml: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.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
+ </p><p>
+ <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>
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+ <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>,
+ <a class="citerefentry" href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
+ <a class="citerefentry" href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
+ <a class="citerefentry" href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
+ <a class="citerefentry" href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
+ <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
+ <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>,
+ <a class="citerefentry" href="glReadBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</span></span></a>,
+ <a class="citerefentry" href="glTexEnv.xml"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>,
+ <a class="citerefentry" href="glTexGen.xml"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>,
+ <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
+ <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
+ <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
+ <a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>,
+ <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
+ <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
+ <a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
+ Copyright <span class="trademark"></span>© 1991-2006
+ Silicon Graphics, Inc. This document is licensed under the SGI
+ Free Software B License. For details, see
+ <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
+ </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blobdiff