Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glInvalidateFramebuffer - 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="glInvalidateFramebuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glInvalidateFramebuffer — invalidate the content some or all of a framebuffer object's attachments</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">glInvalidateFramebuffer</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">numAttachments</var>, </td></tr><tr><td> </td><td>const GLenum * </td><td><var class="pdparam">attachments</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>target</code></em></span></dt><dd><p> | |
5 | The target to which the framebuffer is attached. <em class="parameter"><code>target</code></em> must be | |
6 | <code class="constant">GL_FRAMEBUFFER</code>, <code class="constant">GL_DRAW_FRAMEBUFFER</code>, or <code class="constant">GL_READ_FRAMEBUFFER</code>. | |
7 | </p></dd><dt><span class="term"><em class="parameter"><code>numAttachments</code></em></span></dt><dd><p> | |
8 | The number of entries in the <em class="parameter"><code>attachments</code></em> array. | |
9 | </p></dd><dt><span class="term"><em class="parameter"><code>attachments</code></em></span></dt><dd><p> | |
10 | The address of an array identifying the attachments to be invalidated. | |
11 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
12 | <code class="function">glInvalidateFramebuffer</code> invalidates the content | |
13 | of a specified set of attachments of a framebuffer. The framebuffer | |
14 | whose content to invalidate is indicated by setting <em class="parameter"><code>target</code></em> | |
15 | to the target to which it is bound. <em class="parameter"><code>target</code></em> may be | |
16 | <code class="constant">GL_FRAMEBUFFER</code>, <code class="constant">GL_READ_FRAMEBUFFER</code> or | |
17 | <code class="constant">GL_DRAW_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code> | |
18 | is treated as if it were <code class="constant">GL_DRAW_FRAMEBUFFER</code>. | |
19 | </p><p> | |
20 | The set of attachments whose content to invalidate are specified in an array whose address is given | |
21 | by <em class="parameter"><code>attachments</code></em> and which contains <em class="parameter"><code>numAttachments</code></em> | |
22 | elements. The elements of <em class="parameter"><code>attachments</code></em> must be | |
23 | <code class="constant">GL_DEPTH_ATTACHMENT</code>, <code class="constant">GL_STENCIL_ATTACHMENT</code> | |
24 | <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>, or <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code>, | |
25 | where <span class="emphasis"><em>i</em></span> is between zero and the value of <code class="constant">GL_MAX_FRAMEBUFFER_ATTACHMENTS</code> minus one. | |
26 | Furthermore, if the default framebuffer is bound to <em class="parameter"><code>target</code></em>, then | |
27 | <em class="parameter"><code>attachments</code></em> may contain <code class="constant">GL_FRONT_LEFT</code>, | |
28 | <code class="constant">GL_FRONT_RIGHT</code>, <code class="constant">GL_BACK_LEFT</code>, <code class="constant">GL_BACK_RIGHT</code>, | |
29 | <code class="constant">GL_AUX<span class="emphasis"><em>i</em></span></code>, <code class="constant">GL_ACCUM</code>, | |
30 | <code class="constant">GL_COLOR</code>, <code class="constant">GL_DEPTH</code>, or <code class="constant">GL_STENCIL</code>, identifying that specific buffer. | |
31 | <code class="constant">GL_COLOR</code>, is treated as <code class="constant">GL_BACK_LEFT</code> for a double-buffered context and | |
32 | <code class="constant">GL_FRONT_LEFT</code> for a single-buffered context. | |
33 | After <code class="function">glInvalidateFramebuffer</code> is executed, the contents | |
34 | of the specified attachments become undefined. | |
35 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
36 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the | |
37 | accepted framebuffer target tokens. | |
38 | </p><p> | |
39 | <code class="constant">GL_INVALID_ENUM</code> is generated if any element of <em class="parameter"><code>attachments</code></em> is | |
40 | not one of the accepted framebuffer attachment tokens. | |
41 | </p><p> | |
42 | <code class="constant">GL_INVALID_OPERATION</code> is generated if element of <em class="parameter"><code>attachments</code></em> is | |
43 | <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code> where <span class="emphasis"><em>i</em></span> is greater than or equal | |
44 | to the value of <code class="constant">GL_MAX_COLOR_ATTACHMENTS</code>. | |
45 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
46 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_COLOR_ATTACHMENTS</code> | |
47 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
48 | <a href="glInvalidateTexSubImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexSubImage</span></span></a>, | |
49 | <a href="glInvalidateTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexImage</span></span></a>, | |
50 | <a href="glInvalidateBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferSubData</span></span></a>, | |
51 | <a href="glInvalidateBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferData</span></span></a>, | |
52 | <a href="glInvalidateSubFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateSubFramebuffer</span></span></a>. | |
53 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
54 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
55 | This material may be distributed subject to the terms and conditions set forth in | |
56 | the Open Publication License, v 1.0, 8 June 1999. | |
57 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
58 | </p></div></div></body></html> |