Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glCheckFramebufferStatus"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2010</year> | |
9 | <holder>Khronos Group</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glCheckFramebufferStatus</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glCheckFramebufferStatus</refname> | |
17 | <refpurpose>check the completeness status of a framebuffer</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLenum <function>glCheckFramebufferStatus</function></funcdef> | |
23 | <paramdef>GLenum <parameter>target</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <refsect1 id="parameters"><title>Parameters</title> | |
28 | <variablelist> | |
29 | <varlistentry> | |
30 | <term><parameter>target</parameter></term> | |
31 | <listitem> | |
32 | <para> | |
33 | Specify the target of the framebuffer completeness check. | |
34 | </para> | |
35 | </listitem> | |
36 | </varlistentry> | |
37 | </variablelist> | |
38 | </refsect1> | |
39 | <refsect1 id="description"><title>Description</title> | |
40 | <para> | |
41 | <function>glCheckFramebufferStatus</function> queries the completeness status of the framebuffer object currently bound to <parameter>target</parameter>. | |
42 | <parameter>target</parameter> must be <constant>GL_DRAW_FRAMEBUFFER</constant>, <constant>GL_READ_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. | |
43 | <constant>GL_FRAMEBUFFER</constant> is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>. | |
44 | </para> | |
45 | <para> | |
46 | The return value is <constant>GL_FRAMEBUFFER_COMPLETE</constant> if the framebuffer bound to <parameter>target</parameter> is complete. Otherwise, | |
47 | the return value is determined as follows: | |
48 | <itemizedlist> | |
49 | <listitem> | |
50 | <para> | |
51 | <constant>GL_FRAMEBUFFER_UNDEFINED</constant> is returned if <parameter>target</parameter> is the default framebuffer, but the default framebuffer does not exist. | |
52 | </para> | |
53 | </listitem> | |
54 | <listitem> | |
55 | <para> | |
56 | <constant>GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT</constant> is returned if any of the framebuffer attachment points are framebuffer incomplete. | |
57 | </para> | |
58 | </listitem> | |
59 | <listitem> | |
60 | <para> | |
61 | <constant>GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT</constant> is returned if the framebuffer does not have at least one image attached to it. | |
62 | </para> | |
63 | </listitem> | |
64 | <listitem> | |
65 | <para> | |
66 | <constant>GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER</constant> is returned if the value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</constant> | |
f37e7e3d | 67 | is <constant>GL_NONE</constant> for any color attachment point(s) named by <constant>GL_DRAWBUFFERi</constant>. |
7faf1d71 AW |
68 | </para> |
69 | </listitem> | |
70 | <listitem> | |
71 | <para> | |
72 | <constant>GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER</constant> is returned if <constant>GL_READ_BUFFER</constant> is not <constant>GL_NONE</constant> | |
73 | and the value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</constant> is <constant>GL_NONE</constant> for the color attachment point named | |
74 | by <constant>GL_READ_BUFFER</constant>. | |
75 | </para> | |
76 | </listitem> | |
77 | <listitem> | |
78 | <para> | |
79 | <constant>GL_FRAMEBUFFER_UNSUPPORTED</constant> is returned if the combination of internal formats of the attached images violates | |
80 | an implementation-dependent set of restrictions. | |
81 | </para> | |
82 | </listitem> | |
83 | <listitem> | |
84 | <para> | |
85 | <constant>GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE</constant> is returned if the value of <constant>GL_RENDERBUFFER_SAMPLES</constant> is not the same | |
86 | for all attached renderbuffers; if the value of <constant>GL_TEXTURE_SAMPLES</constant> is the not same for all attached textures; or, if the attached | |
87 | images are a mix of renderbuffers and textures, the value of <constant>GL_RENDERBUFFER_SAMPLES</constant> does not match the value of | |
88 | <constant>GL_TEXTURE_SAMPLES</constant>. | |
89 | </para> | |
90 | </listitem> | |
91 | <listitem> | |
92 | <para> | |
93 | <constant>GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE</constant> is also returned if the value of <constant>GL_TEXTURE_FIXED_SAMPLE_LOCATIONS</constant> is | |
94 | not the same for all attached textures; or, if the attached images are a mix of renderbuffers and textures, the value of <constant>GL_TEXTURE_FIXED_SAMPLE_LOCATIONS</constant> | |
95 | is not <constant>GL_TRUE</constant> for all attached textures. | |
96 | </para> | |
97 | </listitem> | |
98 | <listitem> | |
99 | <para> | |
100 | <constant>GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS</constant> is returned if any framebuffer attachment is layered, and any populated attachment is not layered, | |
101 | or if all populated color attachments are not from textures of the same target. | |
102 | </para> | |
103 | </listitem> | |
104 | </itemizedlist> | |
105 | </para> | |
106 | <para> | |
107 | Additionally, if an error occurs, zero is returned. | |
108 | </para> | |
109 | </refsect1> | |
110 | <refsect1 id="errors"><title>Errors</title> | |
111 | <para> | |
112 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_DRAW_FRAMEBUFFER</constant>, | |
113 | <constant>GL_READ_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. | |
114 | </para> | |
115 | </refsect1> | |
116 | <refsect1 id="seealso"><title>See Also</title> | |
117 | <para> | |
118 | <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, | |
119 | <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry> | |
120 | <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry> | |
121 | </para> | |
122 | </refsect1> | |
123 | <refsect1 id="Copyright"><title>Copyright</title> | |
124 | <para> | |
125 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. | |
126 | This material may be distributed subject to the terms and conditions set forth in | |
127 | the Open Publication License, v 1.0, 8 June 1999. | |
128 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
129 | </para> | |
130 | </refsect1> | |
131 | </refentry> |