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>glInvalidateTexSubImage - 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=
"glInvalidateTexSubImage"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glInvalidateTexSubImage — invalidate a region of 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">glInvalidateTexSubImage
</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>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">xoffset
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">yoffset
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">zoffset
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">width
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">height
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">depth
</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 a subregion of which 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 within which the region resides.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>xoffset
</code></em></span></dt><dd><p>
9 The X offset of the region to be invalidated.
10 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>yoffset
</code></em></span></dt><dd><p>
11 The Y offset of the region to be invalidated.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>zoffset
</code></em></span></dt><dd><p>
13 The Z offset of the region to be invalidated.
14 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>width
</code></em></span></dt><dd><p>
15 The width of the region to be invalidated.
16 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>height
</code></em></span></dt><dd><p>
17 The height of the region to be invalidated.
18 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>depth
</code></em></span></dt><dd><p>
19 The depth of the region to be invalidated.
20 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
21 <code class=
"function">glInvalidateTexSubImage
</code> invalidates all or part of
22 a texture image.
<em class=
"parameter"><code>texture
</code></em> and
<em class=
"parameter"><code>level
</code></em> indicated
23 which texture image is being invalidated. After this command, data in that subregion have undefined
24 values.
<em class=
"parameter"><code>xoffset
</code></em>,
<em class=
"parameter"><code>yoffset
</code></em>,
<em class=
"parameter"><code>zoffset
</code></em>,
<em class=
"parameter"><code>width
</code></em>,
<em class=
"parameter"><code>height
</code></em>, and
<em class=
"parameter"><code>depth
</code></em>
25 are interpreted as they are in
<a href=
"glTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage3D
</span></span></a>. For texture targets that
26 don't have certain dimensions, this command treats those dimensions as
27 having a size of
1. For example, to invalidate a portion of a two-
28 dimensional texture, the application would use
<em class=
"parameter"><code>zoffset
</code></em> equal to zero and
29 <em class=
"parameter"><code>depth
</code></em> equal to one. Cube map textures are treated as an array of six
30 slices in the z-dimension, where a value of
<em class=
"parameter"><code>zoffset
</code></em> is interpreted as
31 specifying face
<code class=
"constant">TEXTURE_CUBE_MAP_POSITIVE_X
</code> +
<em class=
"parameter"><code>zoffset
</code></em>.
33 <em class=
"parameter"><code>level
</code></em> must be greater than or equal to zero and be
34 less than the base
2 logarithm of the maximum texture width, height, or depth.
35 <em class=
"parameter"><code>xoffset
</code></em>,
<em class=
"parameter"><code>yoffset
</code></em> and
<em class=
"parameter"><code>zoffset
</code></em>
36 must be greater than or equal to zero and be less than the width, height or depth
37 of the image, respectively. Furthermore,
<em class=
"parameter"><code>xoffset
</code></em> +
<em class=
"parameter"><code>width
</code></em>,
38 <em class=
"parameter"><code>yoffset
</code></em> +
<em class=
"parameter"><code>height
</code></em>, and
39 <em class=
"parameter"><code>zoffset
</code></em> +
<em class=
"parameter"><code>depth
</code></em> must be less
40 than or equal to the width, height or depth of the image, respectively.
42 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
43 <code class=
"constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY
</code>, level must be zero.
44 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
45 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>xoffset
</code></em>,
46 <em class=
"parameter"><code>yoffset
</code></em> or
<em class=
"parameter"><code>zoffset
</code></em> is less than zero,
47 or if any of them is greater than the size of the image in the corresponding dimension.
49 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>level
</code></em> is
50 less than zero or if it is greater or equal to the base
2 logarithm of the maximum texture width, height, or depth.
52 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if the target of
<em class=
"parameter"><code>texture
</code></em>
53 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
54 <code class=
"constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY
</code> and
<em class=
"parameter"><code>level
</code></em> is not zero.
56 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>texture
</code></em> is not the
57 name of an existing texture object.
58 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
59 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_MAX_TEXTURE_SIZE
</code>
60 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
61 <a href=
"glInvalidateTexImage.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInvalidateTexImage
</span></span></a>,,
62 <a href=
"glInvalidateBufferSubData.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInvalidateBufferSubData
</span></span></a>,
63 <a href=
"glInvalidateBufferData.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInvalidateBufferData
</span></span></a>,
64 <a href=
"glInvalidateFramebuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInvalidateFramebuffer
</span></span></a>,
65 <a href=
"glInvalidateSubFramebuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInvalidateSubFramebuffer
</span></span></a>.
66 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
67 Copyright
<span class=
"trademark"></span>©
2012 Khronos Group.
68 This material may be distributed subject to the terms and conditions set forth in
69 the Open Publication License, v
1.0,
8 June
1999.
70 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
71 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob