upstream-doc/man4/xhtml/glInvalidateTexImage.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glInvalidateTexImage - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glInvalidateTexImage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glInvalidateTexImage — invalidate the entirety a texture image</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glInvalidateTexImage</b>(</code></td><td>GLuint  </td><td><var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>texture</code></em></span></dt><dd><p>
   5                     The name of a texture object to invalidate.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
   7                     The level of detail of the texture object to invalidate.
   8                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glInvalidateTexSubImage</code> invalidates all of
  10             a texture image. <em class="parameter"><code>texture</code></em> and <em class="parameter"><code>level</code></em> indicated
  11             which texture image is being invalidated. After this command, data in the texture image has undefined
  12             values.
  13         </p><p>
  14             <em class="parameter"><code>level</code></em> must be greater than or equal to zero and be
  15             less than the base 2 logarithm of the maximum texture width, height, or depth.
  16         </p><p>
  17             For textures of targets <code class="constant">GL_TEXTURE_RECTANGLE</code>, <code class="constant">GL_TEXTURE_BUFFER</code>, <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>, or
  18             <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>, level must be zero.
  19         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  20             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is
  21             less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.
  22         </p><p>
  23             <code class="constant">GL_INVALID_VALUE</code> is generated if the target of <em class="parameter"><code>texture</code></em>
  24             is any of <code class="constant">GL_TEXTURE_RECTANGLE</code>, <code class="constant">GL_TEXTURE_BUFFER</code>, <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>, or
  25             <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> and <em class="parameter"><code>level</code></em> is not zero.
  26         </p><p>
  27             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not the
  28             name of an existing texture object.
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  30             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_TEXTURE_SIZE</code>
  31         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  32             <a href="glInvalidateTexSubImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexSubImage</span></span></a>,,
  33             <a href="glInvalidateBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferSubData</span></span></a>,
  34             <a href="glInvalidateBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferData</span></span></a>,
  35             <a href="glInvalidateFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateFramebuffer</span></span></a>,
  36             <a href="glInvalidateSubFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateSubFramebuffer</span></span></a>.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  38             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  39             This material may be distributed subject to the terms and conditions set forth in
  40             the Open Publication License, v 1.0, 8 June 1999.
  41             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  42         </p></div></div></body></html>