upstream-man-pages/man4/glInvalidateTexImage.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="glInvalidateTexImage">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glInvalidateTexImage</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glInvalidateTexImage</refname>
  17         <refpurpose>invalidate the entirety a texture image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glInvalidateTexImage</function></funcdef>
  23                 <paramdef>GLuint <parameter>texture</parameter></paramdef>
  24                 <paramdef>GLint <parameter>level</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>texture</parameter></term>
  32             <listitem>
  33                 <para>
  34                     The name of a texture object to invalidate.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>level</parameter></term>
  40             <listitem>
  41                 <para>
  42                     The level of detail of the texture object to invalidate.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glInvalidateTexSubImage</function> invalidates all of
  51             a texture image. <parameter>texture</parameter> and <parameter>level</parameter> indicated
  52             which texture image is being invalidated. After this command, data in the texture image has undefined
  53             values.
  54         </para>
  55         <para>
  56             <parameter>level</parameter> must be greater than or equal to zero and be
  57             less than the base 2 logarithm of the maximum texture width, height, or depth.
  58         </para>
  59         <para>
  60             For textures of targets <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or
  61             <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>, level must be zero.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="errors"><title>Errors</title>
  65         <para>
  66             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is
  67             less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.
  68         </para>
  69         <para>
  70             <constant>GL_INVALID_VALUE</constant> is generated if the target of <parameter>texture</parameter>
  71             is any of <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or
  72             <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> and <parameter>level</parameter> is not zero.
  73         </para>
  74         <para>
  75             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>texture</parameter> is not the
  76             name of an existing texture object.
  77         </para>
  78     </refsect1>
  79     <refsect1 id="associatedgets"><title>Associated Gets</title>
  80         <para>
  81             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_TEXTURE_SIZE</constant>
  82         </para>
  83     </refsect1>
  84     <refsect1 id="seealso"><title>See Also</title>
  85         <para>
  86             <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,
  87             <citerefentry><refentrytitle>glInvalidateBufferSubData</refentrytitle></citerefentry>,
  88             <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,
  90             <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.
  91         </para>
  92     </refsect1>
  93     <refsect1 id="Copyright"><title>Copyright</title>
  94         <para>
  95             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  96             This material may be distributed subject to the terms and conditions set forth in
  97             the Open Publication License, v 1.0, 8 June 1999.
  98             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  99         </para>
 100     </refsect1>
 101 </refentry>