rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glGenRenderbuffers.xml

diff --git a/upstream-doc/man4/glGenRenderbuffers.xml b/upstream-doc/man4/glGenRenderbuffers.xml
new file mode 100644 (file)
index 0000000..70ba5aa
--- /dev/null
+++ b/upstream-doc/man4/glGenRenderbuffers.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
+<refentry id="glGenRenderbuffers">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>2010</year>
+                <holder>Khronos Group</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>glGenRenderbuffers</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>glGenRenderbuffers</refname>
+        <refpurpose>generate renderbuffer object names</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glGenRenderbuffers</function></funcdef>
+                <paramdef>GLsizei <parameter>n</parameter></paramdef>
+                <paramdef>GLuint *<parameter>renderbuffers</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <!-- eqn: ignoring delim $$ -->
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>n</parameter></term>
+            <listitem>
+                <para>
+                    Specifies the number of renderbuffer object names to generate.
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>renderbuffers</parameter></term>
+            <listitem>
+                <para>
+                    Specifies an array in which the generated renderbuffer object names are stored.
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>glGenRenderbuffers</function> returns <parameter>n</parameter> renderbuffer object names in <parameter>renderbuffers</parameter>.
+            There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names
+            was in use immediately before the call to <function>glGenRenderbuffers</function>.
+        </para>
+        <para>
+            Renderbuffer object names returned by a call to <function>glGenRenderbuffers</function> are not returned by subsequent calls, unless
+            they are first deleted with <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>.
+        </para>
+        <para>
+            The names returned in <parameter>renderbuffers</parameter> are marked as used, for the purposes of <function>glGenRenderbuffers</function> only,
+            but they acquire state and type only when they are first bound.
+        </para>
+    </refsect1>
+    <refsect1 id="errors"><title>Errors</title>
+        <para>
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. 
+            This material may be distributed subject to the terms and conditions set forth in 
+            the Open Publication License, v 1.0, 8 June 1999.
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
+        </para>
+    </refsect1>
+</refentry>