upstream-doc/man3/glCopyTexImage1D.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="glCopyTexImage1D">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glCopyTexImage1D</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glCopyTexImage1D</refname>
  17         <refpurpose>copy pixels into a 1D texture image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glCopyTexImage1D</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>GLint <parameter>x</parameter></paramdef>
  27                 <paramdef>GLint <parameter>y</parameter></paramdef>
  28                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  29                 <paramdef>GLint <parameter>border</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>.
  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 internal format of the texture.
  60                     Must be one of the following symbolic constants:
  61                     <constant>GL_COMPRESSED_RED</constant>,
  62                     <constant>GL_COMPRESSED_RG</constant>,
  63                     <constant>GL_COMPRESSED_RGB</constant>,
  64                     <constant>GL_COMPRESSED_RGBA</constant>.
  65                     <constant>GL_COMPRESSED_SRGB</constant>,
  66                     <constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
  67                     <constant>GL_DEPTH_COMPONENT</constant>,
  68                     <constant>GL_DEPTH_COMPONENT16</constant>,
  69                     <constant>GL_DEPTH_COMPONENT24</constant>,
  70                     <constant>GL_DEPTH_COMPONENT32</constant>,
  71                     <constant>GL_RED</constant>,
  72                     <constant>GL_RG</constant>,
  73                     <constant>GL_RGB</constant>,
  74                     <constant>GL_R3_G3_B2</constant>,
  75                     <constant>GL_RGB4</constant>,
  76                     <constant>GL_RGB5</constant>,
  77                     <constant>GL_RGB8</constant>,
  78                     <constant>GL_RGB10</constant>,
  79                     <constant>GL_RGB12</constant>,
  80                     <constant>GL_RGB16</constant>,
  81                     <constant>GL_RGBA</constant>,
  82                     <constant>GL_RGBA2</constant>,
  83                     <constant>GL_RGBA4</constant>,
  84                     <constant>GL_RGB5_A1</constant>,
  85                     <constant>GL_RGBA8</constant>,
  86                     <constant>GL_RGB10_A2</constant>,
  87                     <constant>GL_RGBA12</constant>,
  88                     <constant>GL_RGBA16</constant>,
  89                     <constant>GL_SRGB</constant>,
  90                     <constant>GL_SRGB8</constant>,
  91                     <constant>GL_SRGB_ALPHA</constant>, or
  92                     <constant>GL_SRGB8_ALPHA8</constant>.
  93                 </para>
  94             </listitem>
  95         </varlistentry>
  96         <varlistentry>
  97             <term><parameter>x</parameter></term>
  98             <term><parameter>y</parameter></term>
  99             <listitem>
 100                 <para>
 101                     Specify the window coordinates of the left corner
 102                     of the row of pixels to be copied.
 103                 </para>
 104             </listitem>
 105         </varlistentry>
 106         <varlistentry>
 107             <term><parameter>width</parameter></term>
 108             <listitem>
 109                 <para>
 110                     Specifies the width of the texture image.
 111                     The height of the texture image is 1.
 112                 </para>
 113             </listitem>
 114         </varlistentry>
 115         <varlistentry>
 116             <term><parameter>border</parameter></term>
 117             <listitem>
 118                 <para>
 119                     Must be 0.
 120                 </para>
 121             </listitem>
 122         </varlistentry>
 123         </variablelist>
 124     </refsect1>
 125     <refsect1 id="description"><title>Description</title>
 126         <para>
 127             <function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
 128             <constant>GL_READ_BUFFER</constant>.
 129         </para>
 130         <para>
 131             The screen-aligned pixel row with left corner at
 132             <inlineequation><mml:math>
 133                 <!-- eqn: (x, y): -->
 134                 <mml:mfenced open="(" close=")">
 135                     <mml:mi mathvariant="italic">x</mml:mi>
 136                     <mml:mi mathvariant="italic">y</mml:mi>
 137                 </mml:mfenced>
 138             </mml:math></inlineequation>
 139             and with a length of
 140             <inlineequation><mml:math>
 141                 <!-- eqn: width  +  2 ( border ): -->
 142                 <mml:mrow>
 143                     <mml:mi mathvariant="italic">width</mml:mi>
 144                 </mml:mrow>
 145             </mml:math></inlineequation>
 146             defines the texture array
 147             at the mipmap level specified by <parameter>level</parameter>.
 148             <parameter>internalformat</parameter> specifies the internal format of the texture array.
 149         </para>
 150         <para>
 151             The pixels in the row are processed exactly as if
 152             <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before
 153             final conversion.
 154             At this point all pixel component values are clamped to the range
 155             <inlineequation><mml:math>
 156                 <!-- eqn: [0,1]: -->
 157                 <mml:mfenced open="[" close="]">
 158                     <mml:mn>0</mml:mn>
 159                     <mml:mn>1</mml:mn>
 160                 </mml:mfenced>
 161             </mml:math></inlineequation>
 162             and then converted to the texture's internal format for storage in the texel
 163             array.
 164         </para>
 165         <para>
 166             Pixel ordering is such that lower
 167             <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>
 168             screen coordinates correspond to
 169             lower texture coordinates.
 170         </para>
 171         <para>
 172             If any of the pixels within the specified row of the current
 173             <constant>GL_READ_BUFFER</constant> are outside the window associated with the current
 174             rendering context, then the values obtained for those pixels are undefined.
 175         </para>
 176         <para>
 177             <function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
 178             <constant>GL_READ_BUFFER</constant>.
 179         </para>
 180         <para>
 181             When <parameter>internalformat</parameter> is one of the sRGB  types, the GL does not automatically convert the source pixels to the sRGB color space.  In this case, the <function>glPixelMap</function> function can be used to accomplish the conversion.
 182         </para>
 183     </refsect1>
 184     <refsect1 id="notes"><title>Notes</title>
 185         <para>
 186             1, 2, 3, and 4 are not accepted values for <parameter>internalformat</parameter>.
 187         </para>
 188         <para>
 189             An image with 0 width indicates a NULL texture.
 190         </para>
 191     </refsect1>
 192     <refsect1 id="errors"><title>Errors</title>
 193         <para>
 194             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the allowable values.
 195         </para>
 196         <para>
 197             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
 198         </para>
 199         <para>
 200             <constant>GL_INVALID_VALUE</constant> may be generated if <parameter>level</parameter> is greater
 201             than
 202             <inlineequation><mml:math>
 203                 <!-- eqn: log sub 2 max: -->
 204                 <mml:mrow>
 205                     <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
 206                     <mml:mn>2</mml:mn>
 207                     </mml:msub>
 208                     <mml:mo>&it;</mml:mo>
 209                     <mml:mi mathvariant="italic">max</mml:mi>
 210                 </mml:mrow>
 211             </mml:math></inlineequation>,
 212             where
 213             <inlineequation><mml:math><mml:mi mathvariant="italic">max</mml:mi></mml:math></inlineequation>
 214             is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
 215         </para>
 216         <para>
 217             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>internalformat</parameter> is not an allowable value.
 218         </para>
 219         <para>
 220             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> is less than 0 or greater than
 221             <constant>GL_MAX_TEXTURE_SIZE</constant>.
 222         </para>
 223         <para>
 224             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>border</parameter> is not 0.
 225         </para>
 226         <para>
 227             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is
 228             <constant>GL_DEPTH_COMPONENT</constant>, <constant>GL_DEPTH_COMPONENT16</constant>,
 229             <constant>GL_DEPTH_COMPONENT24</constant>, or <constant>GL_DEPTH_COMPONENT32</constant> and there is no depth
 230             buffer.
 231         </para>
 232     </refsect1>
 233     <refsect1 id="associatedgets"><title>Associated Gets</title>
 234         <para>
 235             <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
 236         </para>
 237     </refsect1>
 238     <refsect1 id="seealso"><title>See Also</title>
 239         <para>
 240             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
 241             <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
 242             <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
 243             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
 244             <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
 245             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
 246             <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
 247             <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
 248             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
 249         </para>
 250     </refsect1>
 251     <refsect1 id="Copyright"><title>Copyright</title>
 252         <para>
 253             Copyright <trademark class="copyright"></trademark> 1991-2006
 254             Silicon Graphics, Inc. This document is licensed under the SGI
 255             Free Software B License. For details, see
 256             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 257         </para>
 258     </refsect1>
 259 </refentry>