upstream-doc/man3/glTexSubImage2D.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="glTexSubImage2D">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glTexSubImage2D</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glTexSubImage2D</refname>
  17         <refpurpose>specify a two-dimensional texture subimage</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glTexSubImage2D</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLint <parameter>level</parameter></paramdef>
  25                 <paramdef>GLint <parameter>xoffset</parameter></paramdef>
  26                 <paramdef>GLint <parameter>yoffset</parameter></paramdef>
  27                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  28                 <paramdef>GLsizei <parameter>height</parameter></paramdef>
  29                 <paramdef>GLenum <parameter>format</parameter></paramdef>
  30                 <paramdef>GLenum <parameter>type</parameter></paramdef>
  31                 <paramdef>const GLvoid * <parameter>data</parameter></paramdef>
  32             </funcprototype>
  33         </funcsynopsis>
  34     </refsynopsisdiv>
  35     <!-- eqn: ignoring delim $$ -->
  36     <para>
  37     </para>
  38     <refsect1 id="parameters"><title>Parameters</title>
  39         <variablelist>
  40         <varlistentry>
  41             <term><parameter>target</parameter></term>
  42             <listitem>
  43                 <para>
  44                     Specifies the target texture.
  45                     Must be <constant>GL_TEXTURE_2D</constant>,
  46                     <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
  47                     <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
  48                     <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
  49                     <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
  50                     <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,
  51                     <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>,
  52                     or <constant>GL_TEXTURE_1D_ARRAY</constant>.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>level</parameter></term>
  58             <listitem>
  59                 <para>
  60                     Specifies the level-of-detail number.
  61                     Level 0 is the base image level.
  62                     Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
  63                 </para>
  64             </listitem>
  65         </varlistentry>
  66         <varlistentry>
  67             <term><parameter>xoffset</parameter></term>
  68             <listitem>
  69                 <para>
  70                     Specifies a texel offset in the x direction within the texture array.
  71                 </para>
  72             </listitem>
  73         </varlistentry>
  74         <varlistentry>
  75             <term><parameter>yoffset</parameter></term>
  76             <listitem>
  77                 <para>
  78                     Specifies a texel offset in the y direction within the texture array.
  79                 </para>
  80             </listitem>
  81         </varlistentry>
  82         <varlistentry>
  83             <term><parameter>width</parameter></term>
  84             <listitem>
  85                 <para>
  86                     Specifies the width of the texture subimage.
  87                 </para>
  88             </listitem>
  89         </varlistentry>
  90         <varlistentry>
  91             <term><parameter>height</parameter></term>
  92             <listitem>
  93                 <para>
  94                     Specifies the height of the texture subimage.
  95                 </para>
  96             </listitem>
  97         </varlistentry>
  98         <varlistentry>
  99             <term><parameter>format</parameter></term>
 100             <listitem>
 101                 <para>
 102                     Specifies the format of the pixel data.
 103                     The following symbolic values are accepted:
 104                     <constant>GL_RED</constant>,
 105                     <constant>GL_RG</constant>,
 106                     <constant>GL_RGB</constant>,
 107                     <constant>GL_BGR</constant>,
 108                     <constant>GL_RGBA</constant>, and
 109                     <constant>GL_BGRA</constant>.
 110                 </para>
 111             </listitem>
 112         </varlistentry>
 113         <varlistentry>
 114             <term><parameter>type</parameter></term>
 115             <listitem>
 116                 <para>
 117                     Specifies the data type of the pixel data.
 118                     The following symbolic values are accepted:
 119                     <constant>GL_UNSIGNED_BYTE</constant>,
 120                     <constant>GL_BYTE</constant>,
 121                     <constant>GL_UNSIGNED_SHORT</constant>,
 122                     <constant>GL_SHORT</constant>,
 123                     <constant>GL_UNSIGNED_INT</constant>,
 124                     <constant>GL_INT</constant>,
 125                     <constant>GL_FLOAT</constant>,
 126                     <constant>GL_UNSIGNED_BYTE_3_3_2</constant>,
 127                     <constant>GL_UNSIGNED_BYTE_2_3_3_REV</constant>,
 128                     <constant>GL_UNSIGNED_SHORT_5_6_5</constant>,
 129                     <constant>GL_UNSIGNED_SHORT_5_6_5_REV</constant>,
 130                     <constant>GL_UNSIGNED_SHORT_4_4_4_4</constant>,
 131                     <constant>GL_UNSIGNED_SHORT_4_4_4_4_REV</constant>,
 132                     <constant>GL_UNSIGNED_SHORT_5_5_5_1</constant>,
 133                     <constant>GL_UNSIGNED_SHORT_1_5_5_5_REV</constant>,
 134                     <constant>GL_UNSIGNED_INT_8_8_8_8</constant>,
 135                     <constant>GL_UNSIGNED_INT_8_8_8_8_REV</constant>,
 136                     <constant>GL_UNSIGNED_INT_10_10_10_2</constant>, and
 137                     <constant>GL_UNSIGNED_INT_2_10_10_10_REV</constant>.
 138                 </para>
 139             </listitem>
 140         </varlistentry>
 141         <varlistentry>
 142             <term><parameter>data</parameter></term>
 143             <listitem>
 144                 <para>
 145                     Specifies a pointer to the image data in memory.
 146                 </para>
 147             </listitem>
 148         </varlistentry>
 149         </variablelist>
 150     </refsect1>
 151     <refsect1 id="description"><title>Description</title>
 152         <para>
 153             Texturing maps a portion of a specified texture image
 154             onto each graphical primitive for which texturing is enabled.
 155         </para>
 156         <para>
 157             <function>glTexSubImage2D</function> redefines a contiguous subregion of an existing two-dimensional
 158             or one-dimensional array texture image.
 159             The texels referenced by <parameter>data</parameter> replace the portion of the
 160             existing texture array with x indices <parameter>xoffset</parameter> and
 161             <inlineequation><mml:math>
 162                 <!-- eqn: xoffset + width - 1: -->
 163                 <mml:mrow>
 164                     <mml:mi mathvariant="italic">xoffset</mml:mi>
 165                     <mml:mo>+</mml:mo>
 166                     <mml:mi mathvariant="italic">width</mml:mi>
 167                     <mml:mo>-</mml:mo>
 168                     <mml:mn>1</mml:mn>
 169                 </mml:mrow>
 170             </mml:math></inlineequation>,
 171             inclusive,
 172             and y indices <parameter>yoffset</parameter> and
 173             <inlineequation><mml:math>
 174                 <!-- eqn: yoffset + height - 1: -->
 175                 <mml:mrow>
 176                     <mml:mi mathvariant="italic">yoffset</mml:mi>
 177                     <mml:mo>+</mml:mo>
 178                     <mml:mi mathvariant="italic">height</mml:mi>
 179                     <mml:mo>-</mml:mo>
 180                     <mml:mn>1</mml:mn>
 181                 </mml:mrow>
 182             </mml:math></inlineequation>,
 183             inclusive.
 184             This region may not include any texels outside the range of the
 185             texture array as it was originally specified.
 186             It is not an error to specify a subtexture with zero width or height, but
 187             such a specification has no effect.
 188         </para>
 189         <para>
 190             If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target
 191             (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is
 192             specified, <parameter>data</parameter> is treated as a byte offset into the buffer object's data store.
 193         </para>
 194     </refsect1>
 195     <refsect1 id="notes"><title>Notes</title>
 196         <para>
 197             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> modes affect texture images.
 198         </para>
 199         <para>
 200             <function>glTexSubImage2D</function> specifies a two-dimensional subtexture for the current texture unit,
 201             specified with <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>.
 202         </para>
 203     </refsect1>
 204     <refsect1 id="errors"><title>Errors</title>
 205         <para>
 206             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_TEXTURE_2D</constant>,
 207             <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
 208             <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
 209             <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
 210             <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
 211             <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
 212             <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
 213         </para>
 214         <para>
 215             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>format</parameter> is not an accepted
 216             format constant.
 217         </para>
 218         <para>
 219             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>type</parameter> is not a type constant.
 220         </para>
 221         <para>
 222             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
 223         </para>
 224         <para>
 225             <constant>GL_INVALID_VALUE</constant> may be generated if <parameter>level</parameter> is greater
 226             than
 227             <inlineequation><mml:math>
 228                 <!-- eqn: log sub 2: -->
 229                 <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
 230                 <mml:mn>2</mml:mn>
 231                 </mml:msub>
 232             </mml:math></inlineequation>
 233             <emphasis>max</emphasis>,
 234             where <emphasis>max</emphasis> is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
 235         </para>
 236         <para>
 237             <constant>GL_INVALID_VALUE</constant> is generated if
 238             <inlineequation><mml:math>
 239                 <!-- eqn: xoffset  <   -b: -->
 240                 <mml:mrow>
 241                     <mml:mi mathvariant="italic">xoffset</mml:mi>
 242                     <mml:mo>&lt;</mml:mo>
 243                     <mml:mn>0</mml:mn>
 244                     </mml:mrow>
 245             </mml:math></inlineequation>,
 246             <inlineequation><mml:math>
 247                 <!-- eqn: (xoffset + width)  >  (w - b): -->
 248                 <mml:mrow>
 249                     <mml:mfenced open="(" close=")">
 250                         <mml:mrow>
 251                             <mml:mi mathvariant="italic">xoffset</mml:mi>
 252                             <mml:mo>+</mml:mo>
 253                             <mml:mi mathvariant="italic">width</mml:mi>
 254                         </mml:mrow>
 255                     </mml:mfenced>
 256                     <mml:mo>&gt;</mml:mo>
 257                     <mml:mi mathvariant="italic">w</mml:mi>
 258                 </mml:mrow>
 259             </mml:math></inlineequation>,
 260             <inlineequation><mml:math>
 261                 <!-- eqn: yoffset  <   -b: -->
 262                 <mml:mrow>
 263                     <mml:mi mathvariant="italic">yoffset</mml:mi>
 264                     <mml:mo>&lt;</mml:mo>
 265                     <mml:mn>0</mml:mn>
 266                 </mml:mrow>
 267             </mml:math></inlineequation>,
 268             or
 269             <inlineequation><mml:math>
 270                 <!-- eqn: (yoffset  +  height)  >  (h - b): -->
 271                 <mml:mrow>
 272                     <mml:mfenced open="(" close=")">
 273                         <mml:mrow>
 274                             <mml:mi mathvariant="italic">yoffset</mml:mi>
 275                             <mml:mo>+</mml:mo>
 276                             <mml:mi mathvariant="italic">height</mml:mi>
 277                         </mml:mrow>
 278                     </mml:mfenced>
 279                     <mml:mo>&gt;</mml:mo>
 280                     <mml:mi mathvariant="italic">h</mml:mi>
 281                 </mml:mrow>
 282             </mml:math></inlineequation>,
 283             where
 284             <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
 285             is the <constant>GL_TEXTURE_WIDTH</constant>, and
 286             <inlineequation><mml:math><mml:mi mathvariant="italic">h</mml:mi></mml:math></inlineequation>
 287             is the <constant>GL_TEXTURE_HEIGHT</constant>
 288             of the texture image being modified.
 289         </para>
 290         <para>
 291             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> or <parameter>height</parameter> is less than 0.
 292         </para>
 293         <para>
 294             <constant>GL_INVALID_OPERATION</constant> is generated if the texture array has not
 295             been defined by a previous <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry> operation.
 296         </para>
 297         <para>
 298             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>type</parameter> is one of
 299             <constant>GL_UNSIGNED_BYTE_3_3_2</constant>,
 300             <constant>GL_UNSIGNED_BYTE_2_3_3_REV</constant>,
 301             <constant>GL_UNSIGNED_SHORT_5_6_5</constant>, or
 302             <constant>GL_UNSIGNED_SHORT_5_6_5_REV</constant>
 303             and <parameter>format</parameter> is not <constant>GL_RGB</constant>.
 304         </para>
 305         <para>
 306             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>type</parameter> is one of
 307             <constant>GL_UNSIGNED_SHORT_4_4_4_4</constant>,
 308             <constant>GL_UNSIGNED_SHORT_4_4_4_4_REV</constant>,
 309             <constant>GL_UNSIGNED_SHORT_5_5_5_1</constant>,
 310             <constant>GL_UNSIGNED_SHORT_1_5_5_5_REV</constant>,
 311             <constant>GL_UNSIGNED_INT_8_8_8_8</constant>,
 312             <constant>GL_UNSIGNED_INT_8_8_8_8_REV</constant>,
 313             <constant>GL_UNSIGNED_INT_10_10_10_2</constant>, or
 314             <constant>GL_UNSIGNED_INT_2_10_10_10_REV</constant>
 315             and <parameter>format</parameter> is neither <constant>GL_RGBA</constant> nor <constant>GL_BGRA</constant>.
 316         </para>
 317         <para>
 318             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 319             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
 320         </para>
 321         <para>
 322             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 323             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
 324             object such that the memory reads required would exceed the data store size.
 325         </para>
 326         <para>
 327             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
 328             <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and <parameter>data</parameter> is not evenly divisible
 329             into the number of bytes needed to store in memory a datum indicated by <parameter>type</parameter>.
 330         </para>
 331     </refsect1>
 332     <refsect1 id="associatedgets"><title>Associated Gets</title>
 333         <para>
 334             <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
 335         </para>
 336         <para>
 337             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
 338         </para>
 339     </refsect1>
 340     <refsect1 id="seealso"><title>See Also</title>
 341         <para>
 342             <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
 343             <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
 344             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
 345             <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
 346             <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
 347             <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
 348             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
 349             <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
 350             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
 351             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
 352             <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
 353             <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>,
 354             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
 355         </para>
 356     </refsect1>
 357     <refsect1 id="Copyright"><title>Copyright</title>
 358         <para>
 359             Copyright <trademark class="copyright"></trademark> 1991-2006
 360             Silicon Graphics, Inc. This document is licensed under the SGI
 361             Free Software B License. For details, see
 362             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 363         </para>
 364     </refsect1>
 365 </refentry>