upstream-man-pages/man4/xhtml/glCompressedTexImage3D.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>glCompressedTexImage3D - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCompressedTexImage3D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCompressedTexImage3D — specify a three-dimensional texture image 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">glCompressedTexImage3D</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>GLenum  </td><td><var class="pdparam">internalformat</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>GLint  </td><td><var class="pdparam">border</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>, <code class="constant">GL_PROXY_TEXTURE_3D</code>,
   7                     <code class="constant">GL_TEXTURE_2D_ARRAY</code> or <code class="constant">GL_PROXY_TEXTURE_2D_ARRAY</code>.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
   9                     Specifies the level-of-detail number.
  10                     Level 0 is the base image level.
  11                     Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p>
  13                     Specifies the format of the compressed image data stored at address <em class="parameter"><code>data</code></em>.
  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 image.
  16                     All implementations support 3D texture images that are at least 16 texels wide.
  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 image.
  19                     All implementations support 3D texture images that are at least 16 texels
  20                     high.
  21                 </p></dd><dt><span class="term"><em class="parameter"><code>depth</code></em></span></dt><dd><p>
  22                     Specifies the depth of the texture image.
  23                     All implementations support 3D texture images that are at least 16 texels
  24                     deep.
  25                 </p></dd><dt><span class="term"><em class="parameter"><code>border</code></em></span></dt><dd><p>
  26                     This value must be 0.
  27                 </p></dd><dt><span class="term"><em class="parameter"><code>imageSize</code></em></span></dt><dd><p>
  28                     Specifies the number of unsigned bytes of image data starting at the
  29                     address specified by <em class="parameter"><code>data</code></em>.
  30                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  31                     Specifies a pointer to the compressed image data in memory.
  32                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  33             Texturing allows elements of an image array to be read by shaders.
  34         </p><p>
  35             <code class="function">glCompressedTexImage3D</code> loads a previously defined, and retrieved, compressed three-dimensional
  36             texture image if <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_3D</code> (see <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>).
  37         </p><p>
  38             If <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_2D_ARRAY</code>, <em class="parameter"><code>data</code></em> is
  39             treated as an array of compressed 2D textures.
  40         </p><p>
  41             If <em class="parameter"><code>target</code></em> is <code class="constant">GL_PROXY_TEXTURE_3D</code> or <code class="constant">GL_PROXY_TEXTURE_2D_ARRAY</code>,
  42             no data is read from <em class="parameter"><code>data</code></em>, but
  43             all of the texture image state is recalculated, checked for consistency,
  44             and checked against the implementation's capabilities.  If the
  45             implementation cannot handle a texture of the requested texture size, it
  46             sets all of the image state to 0, but does not generate an error (see
  47             <a href="glGetError.xml"><span class="citerefentry"><span class="refentrytitle">glGetError</span></span></a>). To query for an entire mipmap array, use an image array level
  48             greater than or equal to 1.
  49         </p><p>
  50             <em class="parameter"><code>internalformat</code></em> must be a known compressed image format (such as <code class="constant">GL_RGTC</code>)
  51             or an extension-specified compressed-texture format.
  52             When a texture is loaded with <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> using a generic compressed
  53             texture format (e.g., <code class="constant">GL_COMPRESSED_RGB</code>), the GL selects from one of
  54             its extensions supporting compressed textures.  In order to load the
  55             compressed texture image using <code class="function">glCompressedTexImage3D</code>, query the compressed texture image's
  56             size and format using <a href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>.
  57         </p><p>
  58             If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target
  59             (see <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
  60             specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.
  61         </p><p>
  62             If the compressed data are arranged into fixed-size blocks of texels, the pixel
  63             storage modes can be used to select a sub-rectangle from a larger containing rectangle.
  64             These pixel storage modes operate in the same way as they do for <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>.
  65             In the following description, denote by <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>s</mml:mi></mml:msub></mml:mrow></mml:math>,
  66             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math>,
  67             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>h</mml:mi></mml:msub></mml:mrow></mml:math>, and
  68             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>d</mml:mi></mml:msub></mml:mrow></mml:math>,
  69             the values of pixel storage modes <code class="constant">GL_UNPACK_COMPRESSED_BLOCK_SIZE</code>,
  70             <code class="constant">GL_UNPACK_COMPRESSED_BLOCK_WIDTH</code>, <code class="constant">GL_UNPACK_COMPRESSED_BLOCK_HEIGHT</code>,
  71             and <code class="constant">GL_UNPACK_COMPRESSED_BLOCK_DEPTH</code>, respectively.
  72             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>s</mml:mi></mml:msub></mml:mrow></mml:math> is
  73             the compressed block size in bytes; <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math>,
  74             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>h</mml:mi></mml:msub></mml:mrow></mml:math>,
  75             and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>d</mml:mi></mml:msub></mml:mrow></mml:math> are the compressed block width, height, and depth in pixels.
  76         </p><p>
  77             By default the pixel storage modes <code class="constant">GL_UNPACK_ROW_LENGTH</code>,
  78             <code class="constant">GL_UNPACK_SKIP_ROWS</code>, <code class="constant">GL_UNPACK_SKIP_PIXELS</code>,
  79             <code class="constant">GL_UNPACK_IMAGE_HEIGHT</code> and <code class="constant">GL_UNPACK_SKIP_IMAGES</code>
  80             are ignored for compressed images. To enable <code class="constant">GL_UNPACK_SKIP_PIXELS</code>
  81             and <code class="constant">GL_UNPACK_ROW_LENGTH</code>, <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>s</mml:mi></mml:msub></mml:mrow></mml:math>
  82             and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math> must both be non-zero.
  83             To also enable <code class="constant">GL_UNPACK_SKIP_ROWS</code> and <code class="constant">GL_UNPACK_IMAGE_HEIGHT</code>,
  84             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>h</mml:mi></mml:msub></mml:mrow></mml:math> must be non-zero.
  85             To also enable <code class="constant">GL_UNPACK_SKIP_IMAGES</code>, <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>d</mml:mi></mml:msub></mml:mrow></mml:math>
  86             must be non-zero. All parameters must be consistent with the compressed format to produce the desired results.
  87         </p><p>
  88             When selecting a sub-rectangle from a compressed image:
  89             </p><div class="itemizedlist"><ul type="disc"><li>the value of <code class="constant">GL_UNPACK_SKIP_PIXELS</code> must be a multiple of <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math>;</li><li>the value of <code class="constant">GL_UNPACK_SKIP_ROWS</code> must be a multiple of <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math>;</li><li>the value of <code class="constant">GL_UNPACK_SKIP_IMAGES</code> must be a multiple of <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mrow><mml:msub><mml:mi>b</mml:mi><mml:mi>w</mml:mi></mml:msub></mml:mrow></mml:math>.</li></ul></div><p>
  90         </p><p>
  91             <em class="parameter"><code>imageSize</code></em> must be equal to:
  92         </p><p>
  93 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" display="block" overflow="scroll">
  94   <mml:mrow>
  95     <mml:msub>
  96       <mml:mi>b</mml:mi>
  97       <mml:mi>s</mml:mi>
  98     </mml:msub>
  99     <mml:mo lspace="2px" rspace="2px">×</mml:mo>
 100     <mml:mfenced open="&#x2308;" close="&#x2309;">
 101       <mml:mfrac>
 102         <mml:mi>width</mml:mi>
 103         <mml:msub>
 104           <mml:mi>b</mml:mi>
 105           <mml:mi>w</mml:mi>
 106         </mml:msub>
 107       </mml:mfrac>
 108     </mml:mfenced>
 109     <mml:mo lspace="2px" rspace="2px">×</mml:mo>
 110     <mml:mfenced open="&#x2308;" close="&#x2309;">
 111       <mml:mfrac>
 112         <mml:mi>height</mml:mi>
 113         <mml:msub>
 114           <mml:mi>b</mml:mi>
 115           <mml:mi>h</mml:mi>
 116         </mml:msub>
 117       </mml:mfrac>
 118     </mml:mfenced>
 119     <mml:mo lspace="2px" rspace="2px">×</mml:mo>
 120     <mml:mfenced open="&#x2308;" close="&#x2309;">
 121       <mml:mfrac>
 122         <mml:mi>depth</mml:mi>
 123         <mml:msub>
 124           <mml:mi>b</mml:mi>
 125           <mml:mi>d</mml:mi>
 126         </mml:msub>
 127       </mml:mfrac>
 128     </mml:mfenced>
 129   </mml:mrow>
 130 </mml:math>
 131         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
 132           <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>internalformat</code></em> is not one of the generic
 133           compressed internal formats:
 134           <code class="constant">GL_COMPRESSED_RED</code>,
 135           <code class="constant">GL_COMPRESSED_RG</code>,
 136           <code class="constant">GL_COMPRESSED_RGB</code>,
 137           <code class="constant">GL_COMPRESSED_RGBA</code>.
 138           <code class="constant">GL_COMPRESSED_SRGB</code>, or
 139           <code class="constant">GL_COMPRESSED_SRGB_ALPHA</code>.
 140         </p><p>
 141             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>imageSize</code></em> is not consistent with
 142             the format, dimensions, and contents of the specified compressed image data.
 143         </p><p>
 144             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0.
 145         </p><p>
 146             <code class="constant">GL_INVALID_OPERATION</code> is generated if parameter combinations are not
 147             supported by the specific compressed internal format as specified in the
 148             specific texture compression extension.
 149         </p><p>
 150             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
 151             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped.
 152         </p><p>
 153             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
 154             <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer
 155             object such that the memory reads required would exceed the data store size.
 156         </p><p>
 157             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.
 158         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
 159             <a href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a>
 160         </p><p>
 161             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_COMPRESSED</code>
 162         </p><p>
 163             <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>
 164         </p><p>
 165             <a href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with arguments <code class="constant">GL_TEXTURE_INTERNAL_FORMAT</code>
 166             and <code class="constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE</code>
 167         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
 168             <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
 169             <a href="glCompressedTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>,
 170             <a href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>,
 171             <a href="glCompressedTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>,
 172             <a href="glCompressedTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
 173             <a href="glCompressedTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage3D</span></span></a>,
 174             <a href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
 175             <a href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
 176             <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
 177             <a href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
 178             <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
 179             <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
 180             <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
 181             <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
 182             <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
 183             <a href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>,
 184             <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
 185         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 186             Copyright <span class="trademark"></span>© 1991-2006
 187             Silicon Graphics, Inc. <span class="trademark"></span>© 2011
 188             Khronos Group. This document is licensed under the SGI
 189             Free Software B License. For details, see
 190             <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
 191         </p></div></div></body></html>