upstream-man-pages/man2/xhtml/glCompressedTexSubImage3D.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glCompressedTexSubImage3D</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCompressedTexSubImage3D"></a><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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glCompressedTexSubImage3D</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">xoffset</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">yoffset</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">zoffset</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">height</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">depth</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">format</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">imageSize</var>, </td></tr><tr><td> </td><td>const GLvoid *  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
   4                     Specifies the target texture.
   5                     Must be <code class="constant">GL_TEXTURE_3D</code>.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
   7                     Specifies the level-of-detail number.
   8                     Level 0 is the base image level.
   9                     Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>xoffset</code></em></span></dt><dd><p>
  11                     Specifies a texel offset in the x direction within the texture array.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>yoffset</code></em></span></dt><dd><p>
  13                     Specifies a texel offset in the y direction within the texture array.
  14                 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
  15                     Specifies the width of the texture subimage.
  16                 </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
  17                     Specifies the height of the texture subimage.
  18                 </p></dd><dt><span class="term"><em class="parameter"><code>depth</code></em></span></dt><dd><p>
  19                     Specifies the depth of the texture subimage.
  20                 </p></dd><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p>
  21                     Specifies the format of the compressed image data stored at address <em class="parameter"><code>data</code></em>.
  22                 </p></dd><dt><span class="term"><em class="parameter"><code>imageSize</code></em></span></dt><dd><p>
  23                     Specifies the number of unsigned bytes of image data starting at the
  24                     address specified by <em class="parameter"><code>data</code></em>.
  25                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  26                     Specifies a pointer to the compressed image data in memory.
  27                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  28             Texturing maps a portion of a specified texture image onto each graphical
  29             primitive for which texturing is enabled.  To enable and disable
  30             three-dimensional texturing, call <a class="citerefentry" href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> and <a class="citerefentry" href="glDisable.xml"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a> with argument
  31             <code class="constant">GL_TEXTURE_3D</code>.
  32         </p><p>
  33             <code class="function">glCompressedTexSubImage3D</code> redefines a contiguous subregion of an existing three-dimensional
  34             texture image.  The texels referenced by <em class="parameter"><code>data</code></em> replace the portion of the
  35             existing texture array with x indices <em class="parameter"><code>xoffset</code></em> and
  36             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  37
  38                 <mml:mrow>
  39                     <mml:mi mathvariant="italic">xoffset</mml:mi>
  40                     <mml:mo>+</mml:mo>
  41                     <mml:mi mathvariant="italic">width</mml:mi>
  42                     <mml:mo>-</mml:mo>
  43                     <mml:mn>1</mml:mn>
  44                 </mml:mrow>
  45             </mml:math>,
  46             and the y indices <em class="parameter"><code>yoffset</code></em> and
  47             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  48
  49                 <mml:mrow>
  50                     <mml:mi mathvariant="italic">yoffset</mml:mi>
  51                     <mml:mo>+</mml:mo>
  52                     <mml:mi mathvariant="italic">height</mml:mi>
  53                     <mml:mo>-</mml:mo>
  54                     <mml:mn>1</mml:mn>
  55                 </mml:mrow>
  56             </mml:math>,
  57             and the z indices <em class="parameter"><code>zoffset</code></em> and
  58             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  59
  60                 <mml:mrow>
  61                     <mml:mi mathvariant="italic">zoffset</mml:mi>
  62                     <mml:mo>+</mml:mo>
  63                     <mml:mi mathvariant="italic">depth</mml:mi>
  64                     <mml:mo>-</mml:mo>
  65                     <mml:mn>1</mml:mn>
  66                 </mml:mrow>
  67             </mml:math>,
  68             inclusive.  This region may not include
  69             any texels outside the range of the texture array as it was originally
  70             specified.  It is not an error to specify a subtexture with width of 0,
  71             but such a specification has no effect.
  72         </p><p>
  73             <em class="parameter"><code>format</code></em> must be an extension-specified
  74             compressed-texture format.  The <em class="parameter"><code>format</code></em> of the compressed texture
  75             image is selected by the GL implementation that compressed it (see
  76             <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>) and should be queried at the time the texture was
  77             compressed with <a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>.
  78         </p><p>
  79             If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target
  80             (see <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
  81             specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.
  82         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  83             <code class="function">glCompressedTexSubImage3D</code> is available only if the GL version is 1.3 or greater.
  84         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  85             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>format</code></em> is one of these generic compressed internal formats:
  86             <code class="constant">GL_COMPRESSED_ALPHA</code>,
  87             <code class="constant">GL_COMPRESSED_LUMINANCE</code>,
  88             <code class="constant">GL_COMPRESSED_LUMINANCE_ALPHA</code>,
  89             <code class="constant">GL_COMPRESSED_INTENSITY</code>,
  90             <code class="constant">GL_COMPRESSED_RGB</code>,
  91             <code class="constant">GL_COMPRESSED_RGBA</code>,
  92                         <code class="constant">GL_COMPRESSED_SLUMINANCE</code>,
  93                         <code class="constant">GL_COMPRESSED_SLUMINANCE_ALPHA</code>,
  94                         <code class="constant">GL_COMPRESSED_SRGB</code>,
  95                         <code class="constant">GL_COMPRESSED_SRGBA</code>, or
  96                         <code class="constant">GL_COMPRESSED_SRGB_ALPHA</code>.
  97         </p><p>
  98             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>imageSize</code></em> is not consistent with
  99             the format, dimensions, and contents of the specified compressed image
 100             data.
 101         </p><p>
 102             <code class="constant">GL_INVALID_OPERATION</code> is generated if parameter combinations are not
 103             supported by the specific compressed internal format as specified in the
 104             specific texture compression extension.
 105         </p><p>
 106             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
 107             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped.
 108         </p><p>
 109             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
 110             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer
 111             object such that the memory reads required would exceed the data store size.
 112         </p><p>
 113             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCompressedTexSubImage3D</code>
 114             is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
 115             and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
 116         </p><p>
 117             Undefined results, including abnormal program termination, are generated if
 118             <em class="parameter"><code>data</code></em> is not encoded in a manner consistent with the extension
 119             specification defining the internal compression format.
 120         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
 121             <a class="citerefentry" href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a>
 122         </p><p>
 123             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_COMPRESSED</code>
 124         </p><p>
 125             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
 126         </p><p>
 127             <a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with arguments <code class="constant">GL_TEXTURE_INTERNAL_FORMAT</code>
 128             and <code class="constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE</code>
 129         </p><p>
 130             <a class="citerefentry" href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_TEXTURE_3D</code>
 131         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
 132             <a class="citerefentry" href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
 133             <a class="citerefentry" href="glColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>,
 134             <a class="citerefentry" href="glCompressedTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>,
 135             <a class="citerefentry" href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>,
 136             <a class="citerefentry" href="glCompressedTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage3D</span></span></a>,
 137             <a class="citerefentry" href="glCompressedTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>,
 138             <a class="citerefentry" href="glCompressedTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
 139             <a class="citerefentry" href="glConvolutionFilter1D.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionFilter1D</span></span></a>,
 140             <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>,
 141             <a class="citerefentry" href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
 142             <a class="citerefentry" href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
 143             <a class="citerefentry" href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
 144             <a class="citerefentry" href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
 145             <a class="citerefentry" href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
 146             <a class="citerefentry" href="glDrawPixels.xml"><span class="citerefentry"><span class="refentrytitle">glDrawPixels</span></span></a>,
 147             <a class="citerefentry" href="glMatrixMode.xml"><span class="citerefentry"><span class="refentrytitle">glMatrixMode</span></span></a>,
 148             <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
 149             <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>,
 150             <a class="citerefentry" href="glTexEnv.xml"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>,
 151             <a class="citerefentry" href="glTexGen.xml"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>,
 152             <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
 153             <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
 154             <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
 155             <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
 156             <a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>,
 157             <a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
 158         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 159             Copyright <span class="trademark"></span>© 1991-2006
 160             Silicon Graphics, Inc. This document is licensed under the SGI
 161             Free Software B License. For details, see
 162             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
 163         </p></div></div></body></html>