rename upstream-man-pages to upstream-doc

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

diff --git a/upstream-doc/man3/glGenSamplers.xml b/upstream-doc/man3/glGenSamplers.xml
new file mode 100644 (file)
index 0000000..f028345
--- /dev/null
+++ b/upstream-doc/man3/glGenSamplers.xml
@@ -0,0 +1,89 @@
+<?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="glGenRenderbuffers">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2010</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glGenSamplers</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glGenSamplers</refname>\r
+        <refpurpose>generate sampler object names</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glGenSamplers</function></funcdef>\r
+                <paramdef>GLsizei <parameter>n</parameter></paramdef>\r
+                <paramdef>GLuint *<parameter>samplers</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <!-- eqn: ignoring delim $$ -->\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>n</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the number of sampler object names to generate.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>samplers</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies an array in which the generated sampler object names are stored.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glGenSamplers</function> returns <parameter>n</parameter> sampler object names in <parameter>samplers</parameter>.\r
+            There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names\r
+            was in use immediately before the call to <function>glGenSamplers</function>.\r
+        </para>\r
+        <para>\r
+            Sampler object names returned by a call to <function>glGenSamplers</function> are not returned by subsequent calls, unless\r
+            they are first deleted with <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>.\r
+        </para>\r
+        <para>\r
+            The names returned in <parameter>samplers</parameter> are marked as used, for the purposes of <function>glGenSamplers</function> only,\r
+            but they acquire state and type only when they are first bound.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="notes"><title>Notes</title>\r
+        <para>\r
+            <function>glGenSamplers</function> is available only if the GL version is 3.3 or higher.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="errors"><title>Errors</title>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDeleteSamplers</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