2009-03-08 00:46:58 +00:00
<?xml version="1.0" encoding="UTF-8"?>
< !DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id= "glCompressedTexSubImage3D" >
<refmeta >
2014-03-28 19:06:55 +00:00
<refmetainfo >
<copyright >
<year > 1991-2006</year>
<holder > Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
2009-03-08 00:46:58 +00:00
<refentrytitle > glCompressedTexSubImage3D</refentrytitle>
<manvolnum > 3G</manvolnum>
</refmeta>
<refnamediv >
<refname > glCompressedTexSubImage3D</refname>
<refpurpose > specify a three-dimensional texture subimage in a compressed format</refpurpose>
</refnamediv>
<refsynopsisdiv > <title > C Specification</title>
<funcsynopsis >
<funcprototype >
<funcdef > void <function > glCompressedTexSubImage3D</function> </funcdef>
<paramdef > GLenum <parameter > target</parameter> </paramdef>
<paramdef > GLint <parameter > level</parameter> </paramdef>
<paramdef > GLint <parameter > xoffset</parameter> </paramdef>
<paramdef > GLint <parameter > yoffset</parameter> </paramdef>
<paramdef > GLint <parameter > zoffset</parameter> </paramdef>
<paramdef > GLsizei <parameter > width</parameter> </paramdef>
<paramdef > GLsizei <parameter > height</parameter> </paramdef>
<paramdef > GLsizei <parameter > depth</parameter> </paramdef>
<paramdef > GLenum <parameter > format</parameter> </paramdef>
<paramdef > GLsizei <parameter > imageSize</parameter> </paramdef>
<paramdef > const GLvoid * <parameter > data</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
2014-03-28 19:06:55 +00:00
<!-- eqn: ignoring delim $$ -->
2009-03-08 00:46:58 +00:00
<refsect1 id= "parameters" > <title > Parameters</title>
<variablelist >
<varlistentry >
<term > <parameter > target</parameter> </term>
<listitem >
<para >
Specifies the target texture.
Must be <constant > GL_TEXTURE_3D</constant> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > level</parameter> </term>
<listitem >
<para >
Specifies the level-of-detail number.
Level 0 is the base image level.
Level <emphasis > n</emphasis> is the <emphasis > n</emphasis> th mipmap reduction image.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > xoffset</parameter> </term>
<listitem >
<para >
Specifies a texel offset in the x direction within the texture array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > yoffset</parameter> </term>
<listitem >
<para >
Specifies a texel offset in the y direction within the texture array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > width</parameter> </term>
<listitem >
<para >
Specifies the width of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > height</parameter> </term>
<listitem >
<para >
Specifies the height of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > depth</parameter> </term>
<listitem >
<para >
Specifies the depth of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > format</parameter> </term>
<listitem >
<para >
Specifies the format of the compressed image data stored at address <parameter > data</parameter> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > imageSize</parameter> </term>
<listitem >
<para >
Specifies the number of unsigned bytes of image data starting at the
address specified by <parameter > data</parameter> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > data</parameter> </term>
<listitem >
<para >
Specifies a pointer to the compressed image data in memory.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id= "description" > <title > Description</title>
<para >
2014-03-28 19:06:55 +00:00
Texturing maps a portion of a specified texture image onto each graphical
primitive for which texturing is enabled. To enable and disable
three-dimensional texturing, call <citerefentry > <refentrytitle > glEnable</refentrytitle> </citerefentry> and <citerefentry > <refentrytitle > glDisable</refentrytitle> </citerefentry> with argument
<constant > GL_TEXTURE_3D</constant> .
2009-03-08 00:46:58 +00:00
</para>
<para >
<function > glCompressedTexSubImage3D</function> redefines a contiguous subregion of an existing three-dimensional
texture image. The texels referenced by <parameter > data</parameter> replace the portion of the
existing texture array with x indices <parameter > xoffset</parameter> and
<inlineequation > <mml:math >
2014-03-28 19:06:55 +00:00
<!-- eqn: xoffset + width - 1: -->
2009-03-08 00:46:58 +00:00
<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> </inlineequation> ,
and the y indices <parameter > yoffset</parameter> and
<inlineequation > <mml:math >
2014-03-28 19:06:55 +00:00
<!-- eqn: yoffset + height - 1: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > yoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > height</mml:mi>
<mml:mo > -</mml:mo>
<mml:mn > 1</mml:mn>
</mml:mrow>
</mml:math> </inlineequation> ,
and the z indices <parameter > zoffset</parameter> and
<inlineequation > <mml:math >
2014-03-28 19:06:55 +00:00
<!-- eqn: zoffset + depth - 1: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > zoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > depth</mml:mi>
<mml:mo > -</mml:mo>
<mml:mn > 1</mml:mn>
</mml:mrow>
</mml:math> </inlineequation> ,
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.
</para>
<para >
2014-03-28 19:06:55 +00:00
<parameter > format</parameter> must be an extension-specified
compressed-texture format. The <parameter > format</parameter> of the compressed texture
2009-03-08 00:46:58 +00:00
image is selected by the GL implementation that compressed it (see
<citerefentry > <refentrytitle > glTexImage3D</refentrytitle> </citerefentry> ) and should be queried at the time the texture was
compressed with <citerefentry > <refentrytitle > glGetTexLevelParameter</refentrytitle> </citerefentry> .
</para>
<para >
2014-03-28 19:06:55 +00:00
If a non-zero named buffer object is bound to the <constant > GL_PIXEL_UNPACK_BUFFER</constant> target
2009-03-08 00:46:58 +00:00
(see <citerefentry > <refentrytitle > glBindBuffer</refentrytitle> </citerefentry> ) while a texture image is
specified, <parameter > data</parameter> is treated as a byte offset into the buffer object's data store.
</para>
</refsect1>
2014-03-28 19:06:55 +00:00
<refsect1 id= "notes" > <title > Notes</title>
<para >
<function > glCompressedTexSubImage3D</function> is available only if the GL version is 1.3 or greater.
</para>
</refsect1>
2009-03-08 00:46:58 +00:00
<refsect1 id= "errors" > <title > Errors</title>
<para >
2014-03-28 19:06:55 +00:00
<constant > GL_INVALID_ENUM</constant> is generated if <parameter > format</parameter> is one of these generic compressed internal formats:
<constant > GL_COMPRESSED_ALPHA</constant> ,
<constant > GL_COMPRESSED_LUMINANCE</constant> ,
<constant > GL_COMPRESSED_LUMINANCE_ALPHA</constant> ,
<constant > GL_COMPRESSED_INTENSITY</constant> ,
<constant > GL_COMPRESSED_RGB</constant> ,
<constant > GL_COMPRESSED_RGBA</constant> ,
<constant > GL_COMPRESSED_SLUMINANCE</constant> ,
<constant > GL_COMPRESSED_SLUMINANCE_ALPHA</constant> ,
<constant > GL_COMPRESSED_SRGB</constant> ,
<constant > GL_COMPRESSED_SRGBA</constant> , or
<constant > GL_COMPRESSED_SRGB_ALPHA</constant> .
2009-03-08 00:46:58 +00:00
</para>
<para >
<constant > GL_INVALID_VALUE</constant> is generated if <parameter > imageSize</parameter> is not consistent with
the format, dimensions, and contents of the specified compressed image
data.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if parameter combinations are not
supported by the specific compressed internal format as specified in the
specific texture compression extension.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
<constant > GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
2014-03-28 19:06:55 +00:00
<constant > GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
2009-03-08 00:46:58 +00:00
object such that the memory reads required would exceed the data store size.
</para>
2014-03-28 19:06:55 +00:00
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if <function > glCompressedTexSubImage3D</function>
is executed between the execution of <citerefentry > <refentrytitle > glBegin</refentrytitle> </citerefentry>
and the corresponding execution of <citerefentry > <refentrytitle > glEnd</refentrytitle> </citerefentry> .
</para>
2009-03-08 00:46:58 +00:00
<para >
Undefined results, including abnormal program termination, are generated if
<parameter > data</parameter> is not encoded in a manner consistent with the extension
specification defining the internal compression format.
</para>
</refsect1>
<refsect1 id= "associatedgets" > <title > Associated Gets</title>
<para >
<citerefentry > <refentrytitle > glGetCompressedTexImage</refentrytitle> </citerefentry>
</para>
<para >
<citerefentry > <refentrytitle > glGet</refentrytitle> </citerefentry> with argument <constant > GL_TEXTURE_COMPRESSED</constant>
</para>
<para >
<citerefentry > <refentrytitle > glGet</refentrytitle> </citerefentry> with argument <constant > GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
</para>
<para >
<citerefentry > <refentrytitle > glGetTexLevelParameter</refentrytitle> </citerefentry> with arguments <constant > GL_TEXTURE_INTERNAL_FORMAT</constant>
and <constant > GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>
</para>
2014-03-28 19:06:55 +00:00
<para >
<citerefentry > <refentrytitle > glIsEnabled</refentrytitle> </citerefentry> with argument <constant > GL_TEXTURE_3D</constant>
</para>
2009-03-08 00:46:58 +00:00
</refsect1>
<refsect1 id= "seealso" > <title > See Also</title>
<para >
<citerefentry > <refentrytitle > glActiveTexture</refentrytitle> </citerefentry> ,
2014-03-28 19:06:55 +00:00
<citerefentry > <refentrytitle > glColorTable</refentrytitle> </citerefentry> ,
2009-03-08 00:46:58 +00:00
<citerefentry > <refentrytitle > glCompressedTexImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCompressedTexImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCompressedTexImage3D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCompressedTexSubImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCompressedTexSubImage2D</refentrytitle> </citerefentry> ,
2014-03-28 19:06:55 +00:00
<citerefentry > <refentrytitle > glConvolutionFilter1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyPixels</refentrytitle> </citerefentry> ,
2009-03-08 00:46:58 +00:00
<citerefentry > <refentrytitle > glCopyTexImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage3D</refentrytitle> </citerefentry> ,
2014-03-28 19:06:55 +00:00
<citerefentry > <refentrytitle > glDrawPixels</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glMatrixMode</refentrytitle> </citerefentry> ,
2009-03-08 00:46:58 +00:00
<citerefentry > <refentrytitle > glPixelStore</refentrytitle> </citerefentry> ,
2014-03-28 19:06:55 +00:00
<citerefentry > <refentrytitle > glPixelTransfer</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexEnv</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexGen</refentrytitle> </citerefentry> ,
2009-03-08 00:46:58 +00:00
<citerefentry > <refentrytitle > glTexImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexImage3D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexSubImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexSubImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexSubImage3D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexParameter</refentrytitle> </citerefentry>
</para>
</refsect1>
<refsect1 id= "Copyright" > <title > Copyright</title>
<para >
2014-03-28 19:06:55 +00:00
Copyright <trademark class= "copyright" > </trademark> 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
2009-03-08 00:46:58 +00:00
<ulink url= "http://oss.sgi.com/projects/FreeB/" > http://oss.sgi.com/projects/FreeB/</ulink> .
</para>
</refsect1>
</refentry>
