upstream-man-pages/man3/glCompressedTexSubImage3D.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glCompressedTexSubImage3D">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glCompressedTexSubImage3D</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glCompressedTexSubImage3D</refname>
  17         <refpurpose>specify a three-dimensional texture subimage in a compressed format</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glCompressedTexSubImage3D</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLint <parameter>level</parameter></paramdef>
  25                 <paramdef>GLint <parameter>xoffset</parameter></paramdef>
  26                 <paramdef>GLint <parameter>yoffset</parameter></paramdef>
  27                 <paramdef>GLint <parameter>zoffset</parameter></paramdef>
  28                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  29                 <paramdef>GLsizei <parameter>height</parameter></paramdef>
  30                 <paramdef>GLsizei <parameter>depth</parameter></paramdef>
  31                 <paramdef>GLenum <parameter>format</parameter></paramdef>
  32                 <paramdef>GLsizei <parameter>imageSize</parameter></paramdef>
  33                 <paramdef>const GLvoid * <parameter>data</parameter></paramdef>
  34             </funcprototype>
  35         </funcsynopsis>
  36     </refsynopsisdiv>
  37     <!-- eqn: ignoring delim $$ -->
  38     <refsect1 id="parameters"><title>Parameters</title>
  39         <variablelist>
  40         <varlistentry>
  41             <term><parameter>target</parameter></term>
  42             <listitem>
  43                 <para>
  44                     Specifies the target texture.
  45                     Must be <constant>GL_TEXTURE_3D</constant>.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>level</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies the level-of-detail number.
  54                     Level 0 is the base image level.
  55                     Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         <varlistentry>
  60             <term><parameter>xoffset</parameter></term>
  61             <listitem>
  62                 <para>
  63                     Specifies a texel offset in the x direction within the texture array.
  64                 </para>
  65             </listitem>
  66         </varlistentry>
  67         <varlistentry>
  68             <term><parameter>yoffset</parameter></term>
  69             <listitem>
  70                 <para>
  71                     Specifies a texel offset in the y direction within the texture array.
  72                 </para>
  73             </listitem>
  74         </varlistentry>
  75         <varlistentry>
  76             <term><parameter>width</parameter></term>
  77             <listitem>
  78                 <para>
  79                     Specifies the width of the texture subimage.
  80                 </para>
  81             </listitem>
  82         </varlistentry>
  83         <varlistentry>
  84             <term><parameter>height</parameter></term>
  85             <listitem>
  86                 <para>
  87                     Specifies the height of the texture subimage.
  88                 </para>
  89             </listitem>
  90         </varlistentry>
  91         <varlistentry>
  92             <term><parameter>depth</parameter></term>
  93             <listitem>
  94                 <para>
  95                     Specifies the depth of the texture subimage.
  96                 </para>
  97             </listitem>
  98         </varlistentry>
  99         <varlistentry>
 100             <term><parameter>format</parameter></term>
 101             <listitem>
 102                 <para>
 103                     Specifies the format of the compressed image data stored at address <parameter>data</parameter>.
 104                 </para>
 105             </listitem>
 106         </varlistentry>
 107         <varlistentry>
 108             <term><parameter>imageSize</parameter></term>
 109             <listitem>
 110                 <para>
 111                     Specifies the number of unsigned bytes of image data starting at the
 112                     address specified by <parameter>data</parameter>.
 113                 </para>
 114             </listitem>
 115         </varlistentry>
 116         <varlistentry>
 117             <term><parameter>data</parameter></term>
 118             <listitem>
 119                 <para>
 120                     Specifies a pointer to the compressed image data in memory.
 121                 </para>
 122             </listitem>
 123         </varlistentry>
 124         </variablelist>
 125     </refsect1>
 126     <refsect1 id="description"><title>Description</title>
 127         <para>
 128             Texturing allows elements of an image array to be read by shaders.
 129         </para>
 130         <para>
 131             <function>glCompressedTexSubImage3D</function> redefines a contiguous subregion of an existing three-dimensional
 132             texture image.  The texels referenced by <parameter>data</parameter> replace the portion of the
 133             existing texture array with x indices <parameter>xoffset</parameter> and
 134             <inlineequation><mml:math>
 135                 <!-- eqn: xoffset  +  width  -  1: -->
 136                 <mml:mrow>
 137                     <mml:mi mathvariant="italic">xoffset</mml:mi>
 138                     <mml:mo>+</mml:mo>
 139                     <mml:mi mathvariant="italic">width</mml:mi>
 140                     <mml:mo>-</mml:mo>
 141                     <mml:mn>1</mml:mn>
 142                 </mml:mrow>
 143             </mml:math></inlineequation>,
 144             and the y indices <parameter>yoffset</parameter> and
 145             <inlineequation><mml:math>
 146                 <!-- eqn: yoffset  +  height  -  1: -->
 147                 <mml:mrow>
 148                     <mml:mi mathvariant="italic">yoffset</mml:mi>
 149                     <mml:mo>+</mml:mo>
 150                     <mml:mi mathvariant="italic">height</mml:mi>
 151                     <mml:mo>-</mml:mo>
 152                     <mml:mn>1</mml:mn>
 153                 </mml:mrow>
 154             </mml:math></inlineequation>,
 155             and the z indices <parameter>zoffset</parameter> and
 156             <inlineequation><mml:math>
 157                 <!-- eqn: zoffset  +  depth  -  1: -->
 158                 <mml:mrow>
 159                     <mml:mi mathvariant="italic">zoffset</mml:mi>
 160                     <mml:mo>+</mml:mo>
 161                     <mml:mi mathvariant="italic">depth</mml:mi>
 162                     <mml:mo>-</mml:mo>
 163                     <mml:mn>1</mml:mn>
 164                 </mml:mrow>
 165             </mml:math></inlineequation>,
 166             inclusive.  This region may not include
 167             any texels outside the range of the texture array as it was originally
 168             specified.  It is not an error to specify a subtexture with width of 0,
 169             but such a specification has no effect.
 170         </para>
 171         <para>
 172             <parameter>internalformat</parameter> must be a known compressed image format (such as <constant>GL_RGTC</constant>)
 173             or an extension-specified compressed-texture format.
 174             The <parameter>format</parameter> of the compressed texture
 175             image is selected by the GL implementation that compressed it (see
 176             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>) and should be queried at the time the texture was
 177             compressed with <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry>.
 178         </para>
 179         <para>
 180             If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target
 181             (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is
 182             specified, <parameter>data</parameter> is treated as a byte offset into the buffer object's data store.
 183         </para>
 184     </refsect1>
 185     <refsect1 id="errors"><title>Errors</title>
 186         <para>
 187           <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is one of the generic compressed internal formats:
 188           <constant>GL_COMPRESSED_RED</constant>,
 189           <constant>GL_COMPRESSED_RG</constant>,
 190           <constant>GL_COMPRESSED_RGB</constant>,
 191           <constant>GL_COMPRESSED_RGBA</constant>.
 192           <constant>GL_COMPRESSED_SRGB</constant>, or
 193           <constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
 194         </para>
 195         <para>
 196             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>imageSize</parameter> is not consistent with
 197             the format, dimensions, and contents of the specified compressed image
 198             data.
 199         </para>
 200         <para>
 201             <constant>GL_INVALID_OPERATION</constant> is generated if parameter combinations are not
 202             supported by the specific compressed internal format as specified in the
 203             specific texture compression extension.
 204         </para>
 205         <para>
 206             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 207             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
 208         </para>
 209         <para>
 210             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 211             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
 212             object such that the memory reads required would exceed the data store size.
 213         </para>
 214         <para>
 215             Undefined results, including abnormal program termination, are generated if
 216             <parameter>data</parameter> is not encoded in a manner consistent with the extension
 217             specification defining the internal compression format.
 218         </para>
 219     </refsect1>
 220     <refsect1 id="associatedgets"><title>Associated Gets</title>
 221         <para>
 222             <citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry>
 223         </para>
 224         <para>
 225             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_COMPRESSED</constant>
 226         </para>
 227         <para>
 228             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
 229         </para>
 230         <para>
 231             <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with arguments <constant>GL_TEXTURE_INTERNAL_FORMAT</constant>
 232             and <constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>
 233         </para>
 234     </refsect1>
 235     <refsect1 id="seealso"><title>See Also</title>
 236         <para>
 237             <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
 238             <citerefentry><refentrytitle>glCompressedTexImage1D</refentrytitle></citerefentry>,
 239             <citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>,
 240             <citerefentry><refentrytitle>glCompressedTexImage3D</refentrytitle></citerefentry>,
 241             <citerefentry><refentrytitle>glCompressedTexSubImage1D</refentrytitle></citerefentry>,
 242             <citerefentry><refentrytitle>glCompressedTexSubImage2D</refentrytitle></citerefentry>,
 243             <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
 244             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
 245             <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
 246             <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
 247             <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
 248             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
 249             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
 250             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
 251             <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
 252             <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
 253             <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>,
 254             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
 255         </para>
 256     </refsect1>
 257     <refsect1 id="Copyright"><title>Copyright</title>
 258         <para>
 259             Copyright <trademark class="copyright"></trademark> 1991-2006
 260             Silicon Graphics, Inc. This document is licensed under the SGI
 261             Free Software B License. For details, see
 262             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 263         </para>
 264     </refsect1>
 265 </refentry>