upstream-doc/man3/xhtml/glCompressedTexSubImage3D.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glCompressedTexSubImage3D</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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>
   5                     Specifies the target texture.
   6                     Must be <code class="constant">GL_TEXTURE_3D</code>.
   7                 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
   8                     Specifies the level-of-detail number.
   9                     Level 0 is the base image level.
  10                     Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
  11                 </p></dd><dt><span class="term"><em class="parameter"><code>xoffset</code></em></span></dt><dd><p>
  12                     Specifies a texel offset in the x direction within the texture array.
  13                 </p></dd><dt><span class="term"><em class="parameter"><code>yoffset</code></em></span></dt><dd><p>
  14                     Specifies a texel offset in the y direction within the texture array.
  15                 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
  16                     Specifies the width of the texture subimage.
  17                 </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
  18                     Specifies the height of the texture subimage.
  19                 </p></dd><dt><span class="term"><em class="parameter"><code>depth</code></em></span></dt><dd><p>
  20                     Specifies the depth of the texture subimage.
  21                 </p></dd><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p>
  22                     Specifies the format of the compressed image data stored at address <em class="parameter"><code>data</code></em>.
  23                 </p></dd><dt><span class="term"><em class="parameter"><code>imageSize</code></em></span></dt><dd><p>
  24                     Specifies the number of unsigned bytes of image data starting at the
  25                     address specified by <em class="parameter"><code>data</code></em>.
  26                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  27                     Specifies a pointer to the compressed image data in memory.
  28                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  29             Texturing allows elements of an image array to be read by shaders.
  30         </p><p>
  31             <code class="function">glCompressedTexSubImage3D</code> redefines a contiguous subregion of an existing three-dimensional
  32             texture image.  The texels referenced by <em class="parameter"><code>data</code></em> replace the portion of the
  33             existing texture array with x indices <em class="parameter"><code>xoffset</code></em> and
  34             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  35
  36                 <mml:mrow>
  37                     <mml:mi mathvariant="italic">xoffset</mml:mi>
  38                     <mml:mo>+</mml:mo>
  39                     <mml:mi mathvariant="italic">width</mml:mi>
  40                     <mml:mo>-</mml:mo>
  41                     <mml:mn>1</mml:mn>
  42                 </mml:mrow>
  43             </mml:math>,
  44             and the y indices <em class="parameter"><code>yoffset</code></em> and
  45             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  46
  47                 <mml:mrow>
  48                     <mml:mi mathvariant="italic">yoffset</mml:mi>
  49                     <mml:mo>+</mml:mo>
  50                     <mml:mi mathvariant="italic">height</mml:mi>
  51                     <mml:mo>-</mml:mo>
  52                     <mml:mn>1</mml:mn>
  53                 </mml:mrow>
  54             </mml:math>,
  55             and the z indices <em class="parameter"><code>zoffset</code></em> and
  56             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  57
  58                 <mml:mrow>
  59                     <mml:mi mathvariant="italic">zoffset</mml:mi>
  60                     <mml:mo>+</mml:mo>
  61                     <mml:mi mathvariant="italic">depth</mml:mi>
  62                     <mml:mo>-</mml:mo>
  63                     <mml:mn>1</mml:mn>
  64                 </mml:mrow>
  65             </mml:math>,
  66             inclusive.  This region may not include
  67             any texels outside the range of the texture array as it was originally
  68             specified.  It is not an error to specify a subtexture with width of 0,
  69             but such a specification has no effect.
  70         </p><p>
  71             <em class="parameter"><code>internalformat</code></em> must be a known compressed image format (such as <code class="constant">GL_RGTC</code>)
  72             or an extension-specified compressed-texture format.
  73             The <em class="parameter"><code>format</code></em> of the compressed texture
  74             image is selected by the GL implementation that compressed it (see
  75             <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>) and should be queried at the time the texture was
  76             compressed with <a href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>.
  77         </p><p>
  78             If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target
  79             (see <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
  80             specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.
  81         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  82           <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:
  83           <code class="constant">GL_COMPRESSED_RED</code>,
  84           <code class="constant">GL_COMPRESSED_RG</code>,
  85           <code class="constant">GL_COMPRESSED_RGB</code>,
  86           <code class="constant">GL_COMPRESSED_RGBA</code>.
  87           <code class="constant">GL_COMPRESSED_SRGB</code>, or
  88           <code class="constant">GL_COMPRESSED_SRGB_ALPHA</code>.
  89         </p><p>
  90             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>imageSize</code></em> is not consistent with
  91             the format, dimensions, and contents of the specified compressed image
  92             data.
  93         </p><p>
  94             <code class="constant">GL_INVALID_OPERATION</code> is generated if parameter combinations are not
  95             supported by the specific compressed internal format as specified in the
  96             specific texture compression extension.
  97         </p><p>
  98             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
  99             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped.
 100         </p><p>
 101             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
 102             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer
 103             object such that the memory reads required would exceed the data store size.
 104         </p><p>
 105             Undefined results, including abnormal program termination, are generated if
 106             <em class="parameter"><code>data</code></em> is not encoded in a manner consistent with the extension
 107             specification defining the internal compression format.
 108         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
 109             <a href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a>
 110         </p><p>
 111             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_COMPRESSED</code>
 112         </p><p>
 113             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
 114         </p><p>
 115             <a href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with arguments <code class="constant">GL_TEXTURE_INTERNAL_FORMAT</code>
 116             and <code class="constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE</code>
 117         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
 118             <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
 119             <a href="glCompressedTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>,
 120             <a href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>,
 121             <a href="glCompressedTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage3D</span></span></a>,
 122             <a href="glCompressedTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>,
 123             <a href="glCompressedTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
 124             <a href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
 125             <a href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
 126             <a href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
 127             <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
 128             <a href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
 129             <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
 130             <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
 131             <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
 132             <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
 133             <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
 134             <a href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>,
 135             <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
 136         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 137             Copyright <span class="trademark"></span>© 1991-2006
 138             Silicon Graphics, Inc. This document is licensed under the SGI
 139             Free Software B License. For details, see
 140             <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
 141         </p></div></div></body></html>