upstream-man-pages/man2/glCompressedTexImage1D.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="glCompressedTexImage1D">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glCompressedTexImage1D</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glCompressedTexImage1D</refname>
  17         <refpurpose>specify a one-dimensional texture image in a compressed format</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glCompressedTexImage1D</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLint <parameter>level</parameter></paramdef>
  25                 <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
  26                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  27                 <paramdef>GLint <parameter>border</parameter></paramdef>
  28                 <paramdef>GLsizei <parameter>imageSize</parameter></paramdef>
  29                 <paramdef>const GLvoid * <parameter>data</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <!-- eqn: ignoring delim $$ -->
  34     <refsect1 id="parameters"><title>Parameters</title>
  35         <variablelist>
  36         <varlistentry>
  37             <term><parameter>target</parameter></term>
  38             <listitem>
  39                 <para>
  40                     Specifies the target texture.
  41                     Must be <constant>GL_TEXTURE_1D</constant> or <constant>GL_PROXY_TEXTURE_1D</constant>.
  42                 </para>
  43             </listitem>
  44         </varlistentry>
  45         <varlistentry>
  46             <term><parameter>level</parameter></term>
  47             <listitem>
  48                 <para>
  49                     Specifies the level-of-detail number.
  50                     Level 0 is the base image level.
  51                     Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
  52                 </para>
  53             </listitem>
  54         </varlistentry>
  55         <varlistentry>
  56             <term><parameter>internalformat</parameter></term>
  57             <listitem>
  58                 <para>
  59                     Specifies the format of the compressed image data stored at address <parameter>data</parameter>.
  60                 </para>
  61             </listitem>
  62         </varlistentry>
  63         <varlistentry>
  64             <term><parameter>width</parameter></term>
  65             <listitem>
  66                 <para>
  67                     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
  68                     <inlineequation><mml:math>
  69                         <!-- eqn: 2 sup n + 2 ( border ):-->
  70                         <mml:mrow>
  71                             <mml:msup><mml:mn>2</mml:mn>
  72                             <mml:mi mathvariant="italic">n</mml:mi>
  73                             </mml:msup>
  74                             <mml:mo>+</mml:mo>
  75                             <mml:mrow>
  76                                 <mml:mn>2</mml:mn>
  77                                 <mml:mo>&af;</mml:mo>
  78                                 <mml:mfenced open="(" close=")">
  79                                     <mml:mi mathvariant="italic">border</mml:mi>
  80                                 </mml:mfenced>
  81                             </mml:mrow>
  82                         </mml:mrow>
  83                     </mml:math></inlineequation>
  84                     for some integer
  85                     <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation>.
  86                     All implementations support texture images that are at least 64 texels wide. The height of the 1D texture image is 1.
  87                 </para>
  88             </listitem>
  89         </varlistentry>
  90         <varlistentry>
  91             <term><parameter>border</parameter></term>
  92             <listitem>
  93                 <para>
  94                     Specifies the width of the border. Must be either 0 or 1.
  95                 </para>
  96             </listitem>
  97         </varlistentry>
  98         <varlistentry>
  99             <term><parameter>imageSize</parameter></term>
 100             <listitem>
 101                 <para>
 102                     Specifies the number of unsigned bytes of image data starting at the address specified by <parameter>data</parameter>.
 103                 </para>
 104             </listitem>
 105         </varlistentry>
 106         <varlistentry>
 107             <term><parameter>data</parameter></term>
 108             <listitem>
 109                 <para>
 110                     Specifies a pointer to the compressed image data in memory.
 111                 </para>
 112             </listitem>
 113         </varlistentry>
 114         </variablelist>
 115     </refsect1>
 116     <refsect1 id="description"><title>Description</title>
 117         <para>
 118             Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled.  To enable and disable one-dimensional texturing, call <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDisable</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_1D</constant>.
 119         </para>
 120         <para>
 121             <function>glCompressedTexImage1D</function> loads a previously defined, and retrieved, compressed one-dimensional texture image if <parameter>target</parameter> is <constant>GL_TEXTURE_1D</constant> (see <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>).
 122         </para>
 123         <para>
 124             If <parameter>target</parameter> is <constant>GL_PROXY_TEXTURE_1D</constant>, no data is read from <parameter>data</parameter>, but
 125             all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities.  If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to 0, but does not generate an error (see <citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry>). To query for an entire mipmap array, use an image array level greater than or equal to 1.
 126         </para>
 127         <para>
 128             <parameter>internalformat</parameter> must be extension-specified compressed-texture format. When a texture is loaded with <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry> using a generic compressed  texture format (e.g., <constant>GL_COMPRESSED_RGB</constant>) the GL selects from one of
 129             its extensions supporting compressed textures.  In order to load the
 130             compressed texture image using <function>glCompressedTexImage1D</function>, query the compressed texture image's size and format using <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry>.
 131         </para>
 132         <para>
 133             If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target
 134             (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is
 135             specified, <parameter>data</parameter> is treated as a byte offset into the buffer object's data store.
 136         </para>
 137     </refsect1>
 138     <refsect1 id="notes"><title>Notes</title>
 139         <para>
 140             <function>glCompressedTexImage1D</function> is available only if the GL version is 1.3 or greater.
 141         </para>
 142         <para>
 143                         Non-power-of-two textures are supported if the GL version is 2.0 or greater, or if the implementation exports the <constant>GL_ARB_texture_non_power_of_two</constant> extension.
 144         </para>
 145     </refsect1>
 146     <refsect1 id="errors"><title>Errors</title>
 147         <para>
 148             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is one of the generic compressed internal formats: <constant>GL_COMPRESSED_ALPHA</constant>,
 149             <constant>GL_COMPRESSED_LUMINANCE</constant>, <constant>GL_COMPRESSED_LUMINANCE_ALPHA</constant>,
 150             <constant>GL_COMPRESSED_INTENSITY</constant>, <constant>GL_COMPRESSED_RGB</constant>, or
 151             <constant>GL_COMPRESSED_RGBA</constant>.
 152         </para>
 153         <para>
 154             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>imageSize</parameter> is not consistent with
 155             the format, dimensions, and contents of the specified compressed image
 156             data.
 157         </para>
 158         <para>
 159             <constant>GL_INVALID_OPERATION</constant> is generated if parameter combinations are not
 160             supported by the specific compressed internal format as specified in the
 161             specific texture compression extension.
 162         </para>
 163         <para>
 164             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 165             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
 166         </para>
 167         <para>
 168             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 169             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
 170             object such that the memory reads required would exceed the data store size.
 171         </para>
 172         <para>
 173             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glCompressedTexImage1D</function>
 174             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
 175             and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
 176         </para>
 177         <para>
 178             Undefined results, including abnormal program termination, are generated if
 179             <parameter>data</parameter> is not encoded in a manner consistent with the extension
 180             specification defining the internal compression format.
 181         </para>
 182     </refsect1>
 183     <refsect1 id="associatedgets"><title>Associated Gets</title>
 184         <para>
 185             <citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry>
 186         </para>
 187         <para>
 188             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_COMPRESSED</constant>
 189         </para>
 190         <para>
 191             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
 192         </para>
 193         <para>
 194             <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with arguments <constant>GL_TEXTURE_INTERNAL_FORMAT</constant>
 195             and <constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>
 196         </para>
 197         <para>
 198             <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_1D</constant>
 199         </para>
 200     </refsect1>
 201     <refsect1 id="seealso"><title>See Also</title>
 202         <para>
 203             <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
 204             <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>,
 205             <citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>,
 206             <citerefentry><refentrytitle>glCompressedTexImage3D</refentrytitle></citerefentry>,
 207             <citerefentry><refentrytitle>glCompressedTexSubImage1D</refentrytitle></citerefentry>,
 208             <citerefentry><refentrytitle>glCompressedTexSubImage2D</refentrytitle></citerefentry>,
 209             <citerefentry><refentrytitle>glCompressedTexSubImage3D</refentrytitle></citerefentry>,
 210             <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>,
 211             <citerefentry><refentrytitle>glCopyPixels</refentrytitle></citerefentry>,
 212             <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
 213             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
 214             <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
 215             <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
 216             <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
 217             <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>,
 218             <citerefentry><refentrytitle>glMatrixMode</refentrytitle></citerefentry>,
 219             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
 220             <citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>,
 221             <citerefentry><refentrytitle>glTexEnv</refentrytitle></citerefentry>,
 222             <citerefentry><refentrytitle>glTexGen</refentrytitle></citerefentry>,
 223             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
 224             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
 225             <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
 226             <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
 227             <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>,
 228             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
 229         </para>
 230     </refsect1>
 231     <refsect1 id="Copyright"><title>Copyright</title>
 232         <para>
 233             Copyright <trademark class="copyright"></trademark> 1991-2006
 234             Silicon Graphics, Inc. This document is licensed under the SGI
 235             Free Software B License. For details, see
 236             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 237         </para>
 238     </refsect1>
 239 </refentry>