Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glInvalidateSubFramebuffer">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2012</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glInvalidateSubFramebuffer</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glInvalidateSubFramebuffer</refname>\r | |
17 | <refpurpose>invalidate the content of a region of some or all of a framebuffer object's attachments</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glInvalidateSubFramebuffer</function></funcdef>\r | |
23 | <paramdef>GLenum <parameter>target</parameter></paramdef>\r | |
24 | <paramdef>GLsizei <parameter>numAttachments</parameter></paramdef>\r | |
25 | <paramdef>const GLenum * <parameter>attachments</parameter></paramdef>\r | |
26 | <paramdef>GLint <parameter>x</parameter></paramdef>\r | |
27 | <paramdef>GLint <parameter>y</parameter></paramdef>\r | |
28 | <paramdef>GLint <parameter>width</parameter></paramdef>\r | |
29 | <paramdef>GLint <parameter>height</parameter></paramdef>\r | |
30 | </funcprototype>\r | |
31 | </funcsynopsis>\r | |
32 | </refsynopsisdiv>\r | |
33 | <refsect1 id="parameters"><title>Parameters</title>\r | |
34 | <variablelist>\r | |
35 | <varlistentry>\r | |
36 | <term><parameter>target</parameter></term>\r | |
37 | <listitem>\r | |
38 | <para>\r | |
39 | The target to which the framebuffer is attached. <parameter>target</parameter> must be\r | |
40 | <constant>GL_FRAMEBUFFER</constant>, <constant>GL_DRAW_FRAMEBUFFER</constant>, or <constant>GL_READ_FRAMEBUFFER</constant>.\r | |
41 | </para>\r | |
42 | </listitem>\r | |
43 | </varlistentry>\r | |
44 | <varlistentry>\r | |
45 | <term><parameter>numAttachments</parameter></term>\r | |
46 | <listitem>\r | |
47 | <para>\r | |
48 | The number of entries in the <parameter>attachments</parameter> array.\r | |
49 | </para>\r | |
50 | </listitem>\r | |
51 | </varlistentry>\r | |
52 | <varlistentry>\r | |
53 | <term><parameter>attachments</parameter></term>\r | |
54 | <listitem>\r | |
55 | <para>\r | |
56 | The address of an array identifying the attachments to be invalidated.\r | |
57 | </para>\r | |
58 | </listitem>\r | |
59 | </varlistentry>\r | |
60 | <varlistentry>\r | |
61 | <term><parameter>x</parameter></term>\r | |
62 | <listitem>\r | |
63 | <para>\r | |
64 | The X offset of the region to be invalidated.\r | |
65 | </para>\r | |
66 | </listitem>\r | |
67 | </varlistentry>\r | |
68 | <varlistentry>\r | |
69 | <term><parameter>y</parameter></term>\r | |
70 | <listitem>\r | |
71 | <para>\r | |
72 | The Y offset of the region to be invalidated.\r | |
73 | </para>\r | |
74 | </listitem>\r | |
75 | </varlistentry>\r | |
76 | <varlistentry>\r | |
77 | <term><parameter>width</parameter></term>\r | |
78 | <listitem>\r | |
79 | <para>\r | |
80 | The width of the region to be invalidated.\r | |
81 | </para>\r | |
82 | </listitem>\r | |
83 | </varlistentry>\r | |
84 | <varlistentry>\r | |
85 | <term><parameter>height</parameter></term>\r | |
86 | <listitem>\r | |
87 | <para>\r | |
88 | The height of the region to be invalidated.\r | |
89 | </para>\r | |
90 | </listitem>\r | |
91 | </varlistentry>\r | |
92 | </variablelist>\r | |
93 | </refsect1>\r | |
94 | <refsect1 id="description"><title>Description</title>\r | |
95 | <para>\r | |
96 | <function>glInvalidateSubFramebuffer</function> invalidates the content of a region\r | |
97 | of a specified set of attachments of a framebuffer. The framebuffer\r | |
98 | whose content to invalidate is indicated by setting <parameter>target</parameter>\r | |
99 | to the target to which it is bound. <parameter>target</parameter> may be\r | |
100 | <constant>GL_FRAMEBUFFER</constant>, <constant>GL_READ_FRAMEBUFFER</constant> or\r | |
101 | <constant>GL_DRAW_FRAMEBUFFER</constant>. <constant>GL_FRAMEBUFFER</constant>\r | |
102 | is treated as if it were <constant>GL_DRAW_FRAMEBUFFER</constant>.\r | |
103 | </para>\r | |
104 | <para>\r | |
105 | A region within a subset of the framebuffer's attachments may be invalidated.\r | |
106 | This set of attachments are specified in an array whose address is given\r | |
107 | by <parameter>attachments</parameter> and which contains <parameter>numAttachments</parameter>\r | |
108 | elements. The elements of <parameter>attachments</parameter> must be\r | |
109 | <constant>GL_DEPTH_ATTACHMENT</constant>, <constant>GL_STENCIL_ATTACHMENT</constant>\r | |
110 | <constant>GL_DEPTH_STENCIL_ATTACHMENT</constant>, or <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant>,\r | |
111 | where <emphasis>i</emphasis> is between zero and the value of <constant>GL_MAX_FRAMEBUFFER_ATTACHMENTS</constant> minus one.\r | |
112 | Furthermore, if the default framebuffer is bound to <parameter>target</parameter>, then\r | |
113 | <parameter>attachments</parameter> may contain <constant>GL_FRONT_LEFT</constant>,\r | |
114 | <constant>GL_FRONT_RIGHT</constant>, <constant>GL_BACK_LEFT</constant>, <constant>GL_BACK_RIGHT</constant>,\r | |
115 | <constant>GL_AUX<emphasis>i</emphasis></constant>, <constant>GL_ACCUM</constant>,\r | |
116 | <constant>GL_COLOR</constant>, <constant>GL_DEPTH</constant>, or <constant>GL_STENCIL</constant>, identifying that specific buffer.\r | |
117 | <constant>GL_COLOR</constant>, is treated as <constant>GL_BACK_LEFT</constant> for a double-buffered context and\r | |
118 | <constant>GL_FRONT_LEFT</constant> for a single-buffered context.\r | |
119 | </para>\r | |
120 | <para>\r | |
121 | The region of the framebuffer attachments to be invalidated is specified\r | |
122 | by <parameter>x</parameter>, <parameter>y</parameter>, <parameter>width</parameter> and <parameter>height</parameter>\r | |
123 | where <parameter>x</parameter> and <parameter>y</parameter> give the offset from the origin (with\r | |
124 | lower-left corner at (0, 0)) and <parameter>width</parameter> and <parameter>height</parameter>\r | |
125 | give the size. Any pixels lying outside of the window allocated\r | |
126 | to the current GL context, or outside of the attachments of the currently\r | |
127 | bound framebuffer object, are ignored.\r | |
128 | After <function>glInvalidateFramebuffer</function> is executed, the contents\r | |
129 | of the specified region of the specified attachments become undefined.\r | |
130 | </para>\r | |
131 | </refsect1>\r | |
132 | <refsect1 id="errors"><title>Errors</title>\r | |
133 | <para>\r | |
134 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the\r | |
135 | accepted framebuffer target tokens.\r | |
136 | </para>\r | |
137 | <para>\r | |
138 | <constant>GL_INVALID_ENUM</constant> is generated if any element of <parameter>attachments</parameter> is\r | |
139 | not one of the accepted framebuffer attachment tokens.\r | |
140 | </para>\r | |
141 | <para>\r | |
142 | <constant>GL_INVALID_OPERATION</constant> is generated if element of <parameter>attachments</parameter> is\r | |
143 | <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant> where <emphasis>i</emphasis> is greater than or equal\r | |
144 | to the value of <constant>GL_MAX_COLOR_ATTACHMENTS</constant>.\r | |
145 | </para>\r | |
146 | </refsect1>\r | |
147 | <refsect1 id="associatedgets"><title>Associated Gets</title>\r | |
148 | <para>\r | |
149 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_COLOR_ATTACHMENTS</constant>\r | |
150 | </para>\r | |
151 | </refsect1>\r | |
152 | <refsect1 id="seealso"><title>See Also</title>\r | |
153 | <para>\r | |
154 | <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,\r | |
155 | <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,\r | |
156 | <citerefentry><refentrytitle>glInvalidateBufferSubData</refentrytitle></citerefentry>,\r | |
157 | <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,\r | |
158 | <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>.\r | |
159 | </para>\r | |
160 | </refsect1>\r | |
161 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
162 | <para>\r | |
163 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
164 | This material may be distributed subject to the terms and conditions set forth in \r | |
165 | the Open Publication License, v 1.0, 8 June 1999.\r | |
166 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
167 | </para>\r | |
168 | </refsect1>\r | |
169 | </refentry>\r |