| 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>glCompressedTexImage3D</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></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> |
| 4 | Specifies the target texture. |
| 5 | Must be <code class="constant">GL_TEXTURE_3D</code> or <code class="constant">GL_PROXY_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>internalformat</code></em></span></dt><dd><p> |
| 11 | Specifies the format of the compressed image data stored at address <em class="parameter"><code>data</code></em>. |
| 12 | </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p> |
| 13 | Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be |
| 14 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 15 | |
| 16 | <mml:mrow> |
| 17 | <mml:msup><mml:mn>2</mml:mn> |
| 18 | <mml:mi mathvariant="italic">n</mml:mi> |
| 19 | </mml:msup> |
| 20 | <mml:mo>+</mml:mo> |
| 21 | <mml:mrow> |
| 22 | <mml:mn>2</mml:mn> |
| 23 | <mml:mo></mml:mo> |
| 24 | <mml:mfenced open="(" close=")"> |
| 25 | <mml:mi mathvariant="italic">border</mml:mi> |
| 26 | </mml:mfenced> |
| 27 | </mml:mrow> |
| 28 | </mml:mrow> |
| 29 | </mml:math> |
| 30 | for some integer |
| 31 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>. |
| 32 | All |
| 33 | implementations support 3D texture images that are at least 16 texels |
| 34 | wide. |
| 35 | </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p> |
| 36 | Specifies the height of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be |
| 37 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 38 | |
| 39 | <mml:mrow> |
| 40 | <mml:msup><mml:mn>2</mml:mn> |
| 41 | <mml:mi mathvariant="italic">n</mml:mi> |
| 42 | </mml:msup> |
| 43 | <mml:mo>+</mml:mo> |
| 44 | <mml:mrow> |
| 45 | <mml:mn>2</mml:mn> |
| 46 | <mml:mo></mml:mo> |
| 47 | <mml:mfenced open="(" close=")"> |
| 48 | <mml:mi mathvariant="italic">border</mml:mi> |
| 49 | </mml:mfenced> |
| 50 | </mml:mrow> |
| 51 | </mml:mrow> |
| 52 | </mml:math> |
| 53 | for some integer |
| 54 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>. |
| 55 | All |
| 56 | implementations support 3D texture images that are at least 16 texels |
| 57 | high. |
| 58 | </p></dd><dt><span class="term"><em class="parameter"><code>depth</code></em></span></dt><dd><p> |
| 59 | Specifies the depth of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be |
| 60 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 61 | |
| 62 | <mml:mrow> |
| 63 | <mml:msup><mml:mn>2</mml:mn> |
| 64 | <mml:mi mathvariant="italic">n</mml:mi> |
| 65 | </mml:msup> |
| 66 | <mml:mo>+</mml:mo> |
| 67 | <mml:mrow> |
| 68 | <mml:mn>2</mml:mn> |
| 69 | <mml:mo></mml:mo> |
| 70 | <mml:mfenced open="(" close=")"> |
| 71 | <mml:mi mathvariant="italic">border</mml:mi> |
| 72 | </mml:mfenced> |
| 73 | </mml:mrow> |
| 74 | </mml:mrow> |
| 75 | </mml:math> |
| 76 | for some integer |
| 77 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>. |
| 78 | All |
| 79 | implementations support 3D texture images that are at least 16 texels |
| 80 | deep. |
| 81 | </p></dd><dt><span class="term"><em class="parameter"><code>border</code></em></span></dt><dd><p> |
| 82 | Specifies the width of the border. |
| 83 | Must be either 0 or 1. |
| 84 | </p></dd><dt><span class="term"><em class="parameter"><code>imageSize</code></em></span></dt><dd><p> |
| 85 | Specifies the number of unsigned bytes of image data starting at the |
| 86 | address specified by <em class="parameter"><code>data</code></em>. |
| 87 | </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p> |
| 88 | Specifies a pointer to the compressed image data in memory. |
| 89 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> |
| 90 | Texturing maps a portion of a specified texture image onto each graphical |
| 91 | primitive for which texturing is enabled. To enable and disable |
| 92 | 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 |
| 93 | <code class="constant">GL_TEXTURE_3D</code>. |
| 94 | </p><p> |
| 95 | <code class="function">glCompressedTexImage3D</code> loads a previously defined, and retrieved, compressed three-dimensional |
| 96 | texture image if <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_3D</code> (see <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>). |
| 97 | </p><p> |
| 98 | If <em class="parameter"><code>target</code></em> is <code class="constant">GL_PROXY_TEXTURE_3D</code>, no data is read from <em class="parameter"><code>data</code></em>, but |
| 99 | all of the texture image state is recalculated, checked for consistency, |
| 100 | and checked against the implementation's capabilities. If the |
| 101 | implementation cannot handle a texture of the requested texture size, it |
| 102 | sets all of the image state to 0, but does not generate an error (see |
| 103 | <a class="citerefentry" 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 |
| 104 | greater than or equal to 1. |
| 105 | </p><p> |
| 106 | <em class="parameter"><code>internalformat</code></em> must be an extension-specified compressed-texture format. |
| 107 | When a texture is loaded with <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> using a generic compressed |
| 108 | texture format (e.g., <code class="constant">GL_COMPRESSED_RGB</code>), the GL selects from one of |
| 109 | its extensions supporting compressed textures. In order to load the |
| 110 | compressed texture image using <code class="function">glCompressedTexImage3D</code>, query the compressed texture image's |
| 111 | size and format using <a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>. |
| 112 | </p><p> |
| 113 | If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target |
| 114 | (see <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is |
| 115 | specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store. |
| 116 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> |
| 117 | <code class="function">glCompressedTexImage3D</code> is available only if the GL version is 1.3 or greater. |
| 118 | </p><p> |
| 119 | Non-power-of-two textures are supported if the GL version is 2.0 or greater, or if the implementation exports the <code class="constant">GL_ARB_texture_non_power_of_two</code> extension. |
| 120 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> |
| 121 | <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: <code class="constant">GL_COMPRESSED_ALPHA</code>, |
| 122 | <code class="constant">GL_COMPRESSED_LUMINANCE</code>, <code class="constant">GL_COMPRESSED_LUMINANCE_ALPHA</code>, |
| 123 | <code class="constant">GL_COMPRESSED_INTENSITY</code>, <code class="constant">GL_COMPRESSED_RGB</code>, or |
| 124 | <code class="constant">GL_COMPRESSED_RGBA</code>. |
| 125 | </p><p> |
| 126 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>imageSize</code></em> is not consistent with |
| 127 | the format, dimensions, and contents of the specified compressed image data. |
| 128 | </p><p> |
| 129 | <code class="constant">GL_INVALID_OPERATION</code> is generated if parameter combinations are not |
| 130 | supported by the specific compressed internal format as specified in the |
| 131 | specific texture compression extension. |
| 132 | </p><p> |
| 133 | <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the |
| 134 | <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped. |
| 135 | </p><p> |
| 136 | <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the |
| 137 | <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer |
| 138 | object such that the memory reads required would exceed the data store size. |
| 139 | </p><p> |
| 140 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCompressedTexImage3D</code> |
| 141 | is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> |
| 142 | and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>. |
| 143 | </p><p> |
| 144 | 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. |
| 145 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> |
| 146 | <a class="citerefentry" href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a> |
| 147 | </p><p> |
| 148 | <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> |
| 149 | </p><p> |
| 150 | <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> |
| 151 | </p><p> |
| 152 | <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> |
| 153 | and <code class="constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE</code> |
| 154 | </p><p> |
| 155 | <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> |
| 156 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> |
| 157 | <a class="citerefentry" href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>, |
| 158 | <a class="citerefentry" href="glColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>, |
| 159 | <a class="citerefentry" href="glCompressedTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>, |
| 160 | <a class="citerefentry" href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>, |
| 161 | <a class="citerefentry" href="glCompressedTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>, |
| 162 | <a class="citerefentry" href="glCompressedTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>, |
| 163 | <a class="citerefentry" href="glCompressedTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage3D</span></span></a>, |
| 164 | <a class="citerefentry" href="glConvolutionFilter1D.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionFilter1D</span></span></a>, |
| 165 | <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>, |
| 166 | <a class="citerefentry" href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>, |
| 167 | <a class="citerefentry" href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>, |
| 168 | <a class="citerefentry" href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>, |
| 169 | <a class="citerefentry" href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>, |
| 170 | <a class="citerefentry" href="glDrawPixels.xml"><span class="citerefentry"><span class="refentrytitle">glDrawPixels</span></span></a>, |
| 171 | <a class="citerefentry" href="glMatrixMode.xml"><span class="citerefentry"><span class="refentrytitle">glMatrixMode</span></span></a>, |
| 172 | <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>, |
| 173 | <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>, |
| 174 | <a class="citerefentry" href="glTexEnv.xml"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>, |
| 175 | <a class="citerefentry" href="glTexGen.xml"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>, |
| 176 | <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>, |
| 177 | <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>, |
| 178 | <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>, |
| 179 | <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>, |
| 180 | <a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>, |
| 181 | <a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a> |
| 182 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> |
| 183 | Copyright <span class="trademark"></span>© 1991-2006 |
| 184 | Silicon Graphics, Inc. This document is licensed under the SGI |
| 185 | Free Software B License. For details, see |
| 186 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. |
| 187 | </p></div></div></body></html> |