Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
390 lines (385 sloc) 17.4 KB
<div class="refentry" id="glCompressedTexSubImage3D">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glCompressedTexSubImage3D — 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>
</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 texture.
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>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>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> redefines a contiguous subregion of an existing three-dimensional
or two-dimensional array 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>format</code></em> must be a known compressed image format (such as <code class="constant">GL_COMPRESSED_R11_EAC</code>)
or an extension-specified compressed-texture format.
</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>format</code></em> is not one of the specific
compressed internal formats:
<code class="constant">GL_COMPRESSED_R11_EAC</code>,
<code class="constant">GL_COMPRESSED_SIGNED_R11_EAC</code>,
<code class="constant">GL_COMPRESSED_RG11_EAC</code>,
<code class="constant">GL_COMPRESSED_SIGNED_RG11_EAC</code>,
<code class="constant">GL_COMPRESSED_RGB8_ETC2</code>,
<code class="constant">GL_COMPRESSED_SRGB8_ETC2</code>,
<code class="constant">GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>,
<code class="constant">GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>,
<code class="constant">GL_COMPRESSED_RGBA8_ETC2_EAC</code>, or
<code class="constant">GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC</code>.
</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. For ETC2/EAC images <code class="constant">GL_INVALID_OPERATION</code>
is generated if <em class="parameter"><code>width</code></em>
is not a multiple of four, and <em class="parameter"><code>width</code></em> + <em class="parameter"><code>xoffset</code></em> is not equal
to the width of the texture level; if <em class="parameter"><code>height</code></em> is not a multiple of four,
and <em class="parameter"><code>height</code></em> + <em class="parameter"><code>yoffset</code></em> is not equal to the height of the texture level;
or if <em class="parameter"><code>xoffset</code></em> or <em class="parameter"><code>yoffset</code></em> is not a multiple of four. The ETC2/EAC
texture compression algorithm supports only two-dimensional images. If format is an ETC2/EAC format,
<code class="function">glCompressedTexSubImage3D</code> will generate an <code class="constant">GL_INVALID_OPERATION</code> error
if target is not <code class="constant">GL_TEXTURE_2D_ARRAY</code>.
</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="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>API 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; " 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="3">
<span class="bold"><strong>OpenGL ES API Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function 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>3.0</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">glCompressedTexSubImage3D</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="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="glCompressedTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</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="glPixelStorei"><span class="citerefentry"><span class="refentrytitle">glPixelStorei</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="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="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
</p>
</div>
</div>