rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glIsFramebuffer.xml

diff --git a/upstream-doc/man3/glIsFramebuffer.xml b/upstream-doc/man3/glIsFramebuffer.xml
new file mode 100644 (file)
index 0000000..73e5bed
--- /dev/null
+++ b/upstream-doc/man3/glIsFramebuffer.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="glIsFramebuffer">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2010</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glIsFramebuffer</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glIsFramebuffer</refname>\r
+        <refpurpose>determine if a name corresponds to a framebuffer object</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>GLboolean <function>glIsFramebuffer</function></funcdef>\r
+                <paramdef>GLuint <parameter>framebuffer</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>framebuffer</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies a value that may be the name of a framebuffer object.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glIsFramebuffer</function> returns <constant>GL_TRUE</constant> if <parameter>framebuffer</parameter> is currently the name of a framebuffer\r
+            object. If <parameter>framebuffer</parameter> is zero, or if <constant>framebuffer</constant> is not the name of a framebuffer object, or if an error\r
+            occurs, <function>glIsFramebuffer</function> returns <constant>GL_FALSE</constant>. If <parameter>framebuffer</parameter> is a name returned by\r
+            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, by that has not yet been bound through a call to\r
+            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>, then the name is not a framebuffer object and <function>glIsFramebuffer</function>\r
+            returns <constant>GL_FALSE</constant>.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
+            This material may be distributed subject to the terms and conditions set forth in \r
+            the Open Publication License, v 1.0, 8 June 1999.\r
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+        </para>\r
+    </refsect1>\r
+</refentry>\r