upstream-doc/man4/glInvalidateTexSubImage.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="glInvalidateTexSubImage">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glInvalidateTexSubImage</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glInvalidateTexSubImage</refname>
  17         <refpurpose>invalidate a region of a texture image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glInvalidateTexSubImage</function></funcdef>
  23                 <paramdef>GLuint <parameter>texture</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>GLint <parameter>zoffset</parameter></paramdef>
  28                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  29                 <paramdef>GLsizei <parameter>height</parameter></paramdef>
  30                 <paramdef>GLsizei <parameter>depth</parameter></paramdef>
  31             </funcprototype>
  32         </funcsynopsis>
  33     </refsynopsisdiv>
  34     <refsect1 id="parameters"><title>Parameters</title>
  35         <variablelist>
  36         <varlistentry>
  37             <term><parameter>texture</parameter></term>
  38             <listitem>
  39                 <para>
  40                     The name of a texture object a subregion of which to invalidate.
  41                 </para>
  42             </listitem>
  43         </varlistentry>
  44         <varlistentry>
  45             <term><parameter>level</parameter></term>
  46             <listitem>
  47                 <para>
  48                     The level of detail of the texture object within which the region resides.
  49                 </para>
  50             </listitem>
  51         </varlistentry>
  52         <varlistentry>
  53             <term><parameter>xoffset</parameter></term>
  54             <listitem>
  55                 <para>
  56                     The X offset of the region to be invalidated.
  57                 </para>
  58             </listitem>
  59         </varlistentry>
  60         <varlistentry>
  61             <term><parameter>yoffset</parameter></term>
  62             <listitem>
  63                 <para>
  64                     The Y offset of the region to be invalidated.
  65                 </para>
  66             </listitem>
  67         </varlistentry>
  68         <varlistentry>
  69             <term><parameter>zoffset</parameter></term>
  70             <listitem>
  71                 <para>
  72                     The Z offset of the region to be invalidated.
  73                 </para>
  74             </listitem>
  75         </varlistentry>
  76         <varlistentry>
  77             <term><parameter>width</parameter></term>
  78             <listitem>
  79                 <para>
  80                     The width of the region to be invalidated.
  81                 </para>
  82             </listitem>
  83         </varlistentry>
  84         <varlistentry>
  85             <term><parameter>height</parameter></term>
  86             <listitem>
  87                 <para>
  88                     The height of the region to be invalidated.
  89                 </para>
  90             </listitem>
  91         </varlistentry>
  92         <varlistentry>
  93             <term><parameter>depth</parameter></term>
  94             <listitem>
  95                 <para>
  96                     The depth of the region to be invalidated.
  97                 </para>
  98             </listitem>
  99         </varlistentry>
 100         </variablelist>
 101     </refsect1>
 102     <refsect1 id="description"><title>Description</title>
 103         <para>
 104             <function>glInvalidateTexSubImage</function> invalidates all or part of
 105             a texture image. <parameter>texture</parameter> and <parameter>level</parameter> indicated
 106             which texture image is being invalidated. After this command, data in that subregion have undefined
 107             values. <parameter>xoffset</parameter>, <parameter>yoffset</parameter>, <parameter>zoffset</parameter>, <parameter>width</parameter>, <parameter>height</parameter>, and <parameter>depth</parameter>
 108             are interpreted as they are in <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>. For texture targets that
 109             don't have certain dimensions, this command treats those dimensions as
 110             having a size of 1. For example, to invalidate a portion of a two-
 111             dimensional texture, the application would use <parameter>zoffset</parameter> equal to zero and
 112             <parameter>depth</parameter> equal to one. Cube map textures are treated as an array of six
 113             slices in the z-dimension, where a value of <parameter>zoffset</parameter> is interpreted as
 114             specifying face <constant>TEXTURE_CUBE_MAP_POSITIVE_X</constant> + <parameter>zoffset</parameter>.
 115         </para>
 116         <para>
 117             <parameter>level</parameter> must be greater than or equal to zero and be
 118             less than the base 2 logarithm of the maximum texture width, height, or depth.
 119             <parameter>xoffset</parameter>, <parameter>yoffset</parameter> and <parameter>zoffset</parameter>
 120             must be greater than or equal to zero and be less than the width, height or depth
 121             of the image, respectively. Furthermore, <parameter>xoffset</parameter> + <parameter>width</parameter>,
 122             <parameter>yoffset</parameter> + <parameter>height</parameter>, and
 123             <parameter>zoffset</parameter> + <parameter>depth</parameter> must be less
 124             than or equal to the width, height or depth of the image, respectively.
 125         </para>
 126         <para>
 127             For textures of targets <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or
 128             <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>, level must be zero.
 129         </para>
 130     </refsect1>
 131     <refsect1 id="errors"><title>Errors</title>
 132         <para>
 133             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>xoffset</parameter>,
 134             <parameter>yoffset</parameter> or <parameter>zoffset</parameter> is less than zero,
 135             or if any of them is greater than the size of the image in the corresponding dimension.
 136         </para>
 137         <para>
 138             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is
 139             less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.
 140         </para>
 141         <para>
 142             <constant>GL_INVALID_VALUE</constant> is generated if the target of <parameter>texture</parameter>
 143             is any of <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or
 144             <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> and <parameter>level</parameter> is not zero.
 145         </para>
 146         <para>
 147             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>texture</parameter> is not the
 148             name of an existing texture object.
 149         </para>
 150     </refsect1>
 151     <refsect1 id="associatedgets"><title>Associated Gets</title>
 152         <para>
 153             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_TEXTURE_SIZE</constant>
 154         </para>
 155     </refsect1>
 156     <refsect1 id="seealso"><title>See Also</title>
 157         <para>
 158             <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,,
 159             <citerefentry><refentrytitle>glInvalidateBufferSubData</refentrytitle></citerefentry>,
 160             <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,
 161             <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,
 162             <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.
 163         </para>
 164     </refsect1>
 165     <refsect1 id="Copyright"><title>Copyright</title>
 166         <para>
 167             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 168             This material may be distributed subject to the terms and conditions set forth in
 169             the Open Publication License, v 1.0, 8 June 1999.
 170             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 171         </para>
 172     </refsect1>
 173 </refentry>