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

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

<div class="refnamediv">

<h2>Name</h2>

<p>glCompressedTexSubImage3D, glCompressedTextureSubImage3D — specify a three-dimensional texture subimage in a compressed format</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">glCompressedTexSubImage3D</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>GLsizei <var class="pdparam">width</var>, </td>

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

<td>const GLvoid * <var class="pdparam">data</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">glCompressedTextureSubImage3D</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>GLsizei <var class="pdparam">width</var>, </td>

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

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

</tr>

<tr>

<td> </td>

<td>const void *<var class="pdparam">data</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 is bound for

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

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

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

<code class="constant">GL_TEXTURE_CUBE_MAP_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">glCompressedTextureSubImage3D</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>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>

<dt>

<span class="term">

<em class="parameter">

<code>depth</code>

</em>

</span>

</dt>

<dd>

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

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>format</code>

</em>

</span>

</dt>

<dd>

<p>Specifies the format of the compressed image data stored at

address <em class="parameter"><code>data</code></em>.</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>imageSize</code>

</em>

</span>

</dt>

<dd>

<p>Specifies the number of unsigned bytes of image data starting

at the address specified by <em class="parameter"><code>data</code></em>.</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>data</code>

</em>

</span>

</dt>

<dd>

<p>Specifies a pointer to the compressed image data in

memory.</p>

</dd>

</dl>

</div>

</div>

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

<h2>Description</h2>

<p>Texturing allows elements of an image array to be read by

shaders.</p>

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

<code class="function">glCompressedTextureSubImage3D</code> redefine a contiguous

subregion of an existing three-dimensional texture image. The texels

referenced by <em class="parameter"><code>data</code></em> replace the portion of the

existing texture array with x indices <em class="parameter"><code>xoffset</code></em> and

<math overflow="scroll">

<mrow>

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

<mo>+</mo>

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

<mo>-</mo>

<mn>1</mn>

</mrow>

</math>,

and the y indices <em class="parameter"><code>yoffset</code></em> and

<math overflow="scroll">

<mrow>

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

<mo>+</mo>

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

<mo>-</mo>

<mn>1</mn>

</mrow>

</math>,

and the z indices <em class="parameter"><code>zoffset</code></em> and

<math overflow="scroll">

<mrow>

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

<mo>+</mo>

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

<mo>-</mo>

<mn>1</mn>

</mrow>

</math>,

inclusive. This region may not include

any texels outside the range of the texture array as it was originally

specified. It is not an error to specify a subtexture with width of 0,

but such a specification has no effect.

</p>

<p>

<em class="parameter"><code>internalformat</code></em> must be a known compressed image format (such as <code class="constant">GL_RGTC</code>)

or an extension-specified compressed-texture format.

The <em class="parameter"><code>format</code></em> of the compressed texture

image is selected by the GL implementation that compressed it (see

<a class="citerefentry" href="glTexImage3D"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>) and should be queried at the time the texture was

compressed with <a class="citerefentry" href="glGetTexLevelParameter"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>.

</p>

<p>

If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target

(see <a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is

specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.

</p>

</div>

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

<h2>Errors</h2>

<p>

<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>internalformat</code></em> is one of the generic compressed internal formats:

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

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

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

<code class="constant">GL_COMPRESSED_RGBA</code>.

<code class="constant">GL_COMPRESSED_SRGB</code>, or

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

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

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

<em class="parameter"><code>target</code></em> is not

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

<code class="constant">GL_TEXTURE_3D</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">glCompressedTextureSubImage3D</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>imageSize</code></em> is not consistent with the format,

dimensions, and contents of the specified compressed image data.</p>

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

combinations are not supported by the specific compressed internal format

as specified in the specific texture compression extension.</p>

<p><code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero

buffer object name is bound to the

<code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's

data store is currently mapped.</p>

<p><code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero

buffer object name is bound to the

<code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be

unpacked from the buffer object such that the memory reads required would

exceed the data store size.</p>

<p>Undefined results, including abnormal program termination, are

generated if <em class="parameter"><code>data</code></em> is not encoded in a manner

consistent with the extension specification defining the internal

compression format.</p>

</div>

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

<h2>Associated Gets</h2>

<p>

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

</p>

<p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_COMPRESSED</code>

</p>

<p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>

</p>

<p>

<a class="citerefentry" href="glGetTexLevelParameter"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with arguments <code class="constant">GL_TEXTURE_INTERNAL_FORMAT</code>

and <code class="constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE</code>

</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">glCompressedTexSubImage3D</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">glCompressedTextureSubImage3D</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="glActiveTexture"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,

<a class="citerefentry" href="glCompressedTexImage1D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>,

<a class="citerefentry" href="glCompressedTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>,

<a class="citerefentry" href="glCompressedTexImage3D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage3D</span></span></a>,

<a class="citerefentry" href="glCompressedTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>,

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

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

</p>

</div>

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

<h2>Copyright</h2>

<p>

Copyright © 1991-2006 Silicon Graphics, Inc.

Copyright © 2010-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>