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="glIsFramebuffer"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2010</year> | |
9 | <holder>Khronos Group</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glIsFramebuffer</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glIsFramebuffer</refname> | |
17 | <refpurpose>determine if a name corresponds to a framebuffer object</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLboolean <function>glIsFramebuffer</function></funcdef> | |
23 | <paramdef>GLuint <parameter>framebuffer</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <refsect1 id="parameters"><title>Parameters</title> | |
28 | <variablelist> | |
29 | <varlistentry> | |
30 | <term><parameter>framebuffer</parameter></term> | |
31 | <listitem> | |
32 | <para> | |
33 | Specifies a value that may be the name of a framebuffer object. | |
34 | </para> | |
35 | </listitem> | |
36 | </varlistentry> | |
37 | </variablelist> | |
38 | </refsect1> | |
39 | <refsect1 id="description"><title>Description</title> | |
40 | <para> | |
41 | <function>glIsFramebuffer</function> returns <constant>GL_TRUE</constant> if <parameter>framebuffer</parameter> is currently the name of a framebuffer | |
42 | object. If <parameter>framebuffer</parameter> is zero, or if <constant>framebuffer</constant> is not the name of a framebuffer object, or if an error | |
43 | occurs, <function>glIsFramebuffer</function> returns <constant>GL_FALSE</constant>. If <parameter>framebuffer</parameter> is a name returned by | |
44 | <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, by that has not yet been bound through a call to | |
45 | <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>, then the name is not a framebuffer object and <function>glIsFramebuffer</function> | |
46 | returns <constant>GL_FALSE</constant>. | |
47 | </para> | |
48 | </refsect1> | |
49 | <refsect1 id="seealso"><title>See Also</title> | |
50 | <para> | |
51 | <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, | |
52 | <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>, | |
53 | <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry> | |
54 | </para> | |
55 | </refsect1> | |
56 | <refsect1 id="Copyright"><title>Copyright</title> | |
57 | <para> | |
58 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. | |
59 | This material may be distributed subject to the terms and conditions set forth in | |
60 | the Open Publication License, v 1.0, 8 June 1999. | |
61 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
62 | </para> | |
63 | </refsect1> | |
64 | </refentry> |