<div class="refentry" id="glCopyTexSubImage3D">

<div class="titlepage"></div>

<div class="refnamediv">

<h2>Name</h2>

<p>glCopyTexSubImage3D, glCopyTextureSubImage3D — copy a three-dimensional texture subimage</p>

</div>

<div class="refsynopsisdiv">

<h2>C Specification</h2>

<div class="funcsynopsis">

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glCopyTexSubImage3D</strong>(</code>

</td>

<td>GLenum <var class="pdparam">target</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">level</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">xoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">yoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">zoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">x</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">y</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizei <var class="pdparam">width</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizei <var class="pdparam">height</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glCopyTextureSubImage3D</strong>(</code>

</td>

<td>GLuint <var class="pdparam">texture</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">level</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">xoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">yoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">zoffset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">x</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLint <var class="pdparam">y</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizei <var class="pdparam">width</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizei <var class="pdparam">height</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

</div>

</div>

<div class="refsect1" id="parameters">

<h2>Parameters</h2>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<em class="parameter">

<code>target</code>

</em>

</span>

</dt>

<dd>

<p>Specifies the target to which the texture object is bound for

<code class="function">glCopyTexSubImage3D</code> function. Must be

<code class="constant">GL_TEXTURE_3D</code> or

<code class="constant">GL_TEXTURE_2D_ARRAY</code>.</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>texture</code>

</em>

</span>

</dt>

<dd>

<p>Specifies the texture object name for

<code class="function">glCopyTextureSubImage3D</code> function.</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 a texel offset in the x direction within the texture

array.</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>yoffset</code>

</em>

</span>

</dt>

<dd>

<p>Specifies a texel offset in the y direction within the texture

array.</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>zoffset</code>

</em>

</span>

</dt>

<dd>

<p>Specifies a texel offset in the z direction 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 lower left corner of the

rectangular region 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>

<dt>

<span class="term">

<em class="parameter">

<code>height</code>

</em>

</span>

</dt>

<dd>

<p>Specifies the height of the texture subimage.</p>

</dd>

</dl>

</div>

</div>

<div class="refsect1" id="description">

<h2>Description</h2>

<p><code class="function">glCopyTexSubImage3D</code> and

<code class="function">glCopyTextureSubImage3D</code> functions replace a rectangular portion of a three-dimensional

or two-dimensional array 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="glTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>).

</p>

<p>

The screen-aligned pixel rectangle with lower left corner at

(<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) and with

width <em class="parameter"><code>width</code></em> and height <em class="parameter"><code>height</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, and y indices <em class="parameter"><code>yoffset</code></em> through

<math overflow="scroll">

<mrow>

<mi mathvariant="italic">yoffset</mi>

<mo>+</mo>

<mi mathvariant="italic">height</mi>

<mo>-</mo>

<mn>1</mn>

</mrow>

</math>,

inclusive, at z index <em class="parameter"><code>zoffset</code></em> and at the mipmap level specified by <em class="parameter"><code>level</code></em>.

</p>

<p>

The pixels in the rectangle are processed exactly as if

<a class="citerefentry" href="glReadPixels"><span class="citerefentry"><span class="refentrytitle">glReadPixels</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>

The destination rectangle in the texture array may not include any texels

outside the texture array as it was originally specified.

It is not an error to specify a subtexture with zero width or height, but

such a specification has no effect.

</p>

<p>

If any of the pixels within the specified rectangle 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>,

<span class="emphasis"><em>height</em></span>, <span class="emphasis"><em>depth</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" id="notes">

<h2>Notes</h2>

<p>

<a class="citerefentry" href="glPixelStore"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> modes affect texture images.

</p>

</div>

<div class="refsect1" id="errors">

<h2>Errors</h2>

<p><code class="constant">GL_INVALID_ENUM</code> is generated by

<code class="function">glCopyTexSubImage3D</code> if <em class="parameter"><code>target</code></em>

is not <code class="constant">GL_TEXTURE_3D</code>,

<code class="constant">GL_TEXTURE_2D_ARRAY</code> or

<code class="constant">GL_TEXTURE_CUBE_MAP_ARRAY</code>.</p>

<p><code class="constant">GL_INVALID_OPERATION</code> is generated by

<code class="function">glCopyTextureSubImage3D</code> if the effective target is

not <code class="constant">GL_TEXTURE_3D</code>,

<code class="constant">GL_TEXTURE_2D_ARRAY</code>,

<code class="constant">GL_TEXTURE_CUBE_MAP_ARRAY</code> or

<code class="constant">GL_TEXTURE_CUBE_MAP</code>.</p>

<p><code class="constant">GL_INVALID_FRAMEBUFFER_OPERATION</code> is generated

if the object bound to <code class="constant">GL_READ_FRAMEBUFFER_BINDING</code> is

not framebuffer complete.</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="glTexImage3D"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> or <a class="citerefentry" href="glTexStorage3D"><span class="citerefentry"><span class="refentrytitle">glTexStorage3D</span></span></a> operation.</p>

<p><code class="constant">GL_INVALID_OPERATION</code> is generated by

<code class="function">glCopyTextureSubImage3D</code> if

<em class="parameter"><code>texture</code></em> is not the name of an existing texture

object.</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>&gt;</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

<math overflow="scroll"><mi mathvariant="italic">max</mi></math>

is the returned value of <code class="constant">GL_MAX_3D_TEXTURE_SIZE</code> if <em class="parameter"><code>target</code></em>

is <code class="constant">GL_TEXTURE_3D</code> or the returned value of <code class="constant">GL_MAX_ARRAY_TEXTURE_LAYERS</code>

if <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_2D_ARRAY</code>.

</p>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if

<math overflow="scroll">

<mrow>

<mi mathvariant="italic">xoffset</mi>

<mo>&lt;</mo>

<mn>0</mn>

</mrow>

</math>,

<math overflow="scroll">

<mrow>

<mfenced open="(" close=")">

<mrow>

<mi mathvariant="italic">xoffset</mi>

<mo>+</mo>

<mi mathvariant="italic">width</mi>

</mrow>

</mfenced>

<mo>&gt;</mo>

<mi mathvariant="italic">w</mi>

</mrow>

</math>,

<math overflow="scroll">

<mrow>

<mi mathvariant="italic">yoffset</mi>

<mo>&lt;</mo>

<mn>0</mn>

</mrow>

</math>,

<math overflow="scroll">

<mrow>

<mfenced open="(" close=")">

<mrow>

<mi mathvariant="italic">yoffset</mi>

<mo>+</mo>

<mi mathvariant="italic">height</mi>

</mrow>

</mfenced>

<mo>&gt;</mo>

<mi mathvariant="italic">h</mi>

</mrow>

</math>,

<math overflow="scroll">

<mrow>

<mi mathvariant="italic">zoffset</mi>

<mo>&lt;</mo>

<mn>0</mn>

</mrow>

</math>,

or

<math overflow="scroll">

<mrow>

<mfenced open="(" close=")">

<mrow>

<mi mathvariant="italic">zoffset</mi>

<mo>+</mo>

<mn>1</mn>

</mrow>

</mfenced>

<mo>&gt;</mo>

<mi mathvariant="italic">d</mi>

</mrow>

</math>,

where

<math overflow="scroll"><mi mathvariant="italic">w</mi></math>

is the <code class="constant">GL_TEXTURE_WIDTH</code>,

<math overflow="scroll"><mi mathvariant="italic">h</mi></math>

is the <code class="constant">GL_TEXTURE_HEIGHT</code>,

<math overflow="scroll"><mi mathvariant="italic">d</mi></math>

is the <code class="constant">GL_TEXTURE_DEPTH</code> and

of the texture image being modified.

Note that

<math overflow="scroll"><mi mathvariant="italic">w</mi></math>,

<math overflow="scroll"><mi mathvariant="italic">h</mi></math>,

and

<math overflow="scroll"><mi mathvariant="italic">d</mi></math>

include twice the border width.

</p>

<p><code class="constant">GL_INVALID_OPERATION</code> is generated

if:</p>

<div class="itemizedlist">

<ul class="itemizedlist" style="list-style-type: disc; ">

<li class="listitem">

<p>the read buffer is <code class="constant">GL_NONE</code>, or</p>

</li>

<li class="listitem">

<p>the value of <code class="constant">GL_READ_FRAMEBUFFER_BINDING</code>

is non-zero, and:</p>

<div class="itemizedlist">

<ul class="itemizedlist" style="list-style-type: circle; ">

<li class="listitem">

<p>the read buffer selects an attachment that has no image

attached, or</p>

</li>

<li class="listitem">

<p>the effective value of

<code class="constant">GL_SAMPLE_BUFFERS</code> for the read

framebuffer is one.</p>

</li>

</ul>

</div>

</li>

</ul>

</div>

</div>

<div class="refsect1" id="associatedgets">

<h2>Associated Gets</h2>

<p>

<a class="citerefentry" href="glGetTexImage"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>

</p>

</div>

{$pipelinestall}{$examples}

<div class="refsect1" id="versions">

<h2>Version Support</h2>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; "/>

<col style="text-align: center; " class="firstvers"/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; " class="lastvers"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; ">

</th>

<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">

<span class="bold"><strong>OpenGL Version</strong></span>

</th>

</tr>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>Function / Feature Name</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.4</strong></span>

</th>

<th style="text-align: center; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.5</strong></span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="function">glCopyTexSubImage3D</code>

</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">

<code class="function">glCopyTextureSubImage3D</code>

</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

<div class="refsect1" id="seealso">

<h2>See Also</h2>

<p>

<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="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="glReadBuffer"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</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" id="Copyright">

<h2>Copyright</h2>

<p>

Copyright © 1991-2006

Silicon Graphics, Inc.

Copyright © 2012-2014 Khronos Group.

This document is licensed under the SGI

Free Software B License. For details, see

<a class="link" 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>