add upstream documentation

[clinton/guile-figl.git] / upstream-man-pages / man3 / glRenderbufferStorageMultisample.xml

diff --git a/upstream-man-pages/man3/glRenderbufferStorageMultisample.xml b/upstream-man-pages/man3/glRenderbufferStorageMultisample.xml
new file mode 100644 (file)
index 0000000..4a01c0b
--- /dev/null
+++ b/upstream-man-pages/man3/glRenderbufferStorageMultisample.xml
@@ -0,0 +1,136 @@
+<?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="glRenderbufferStorageMultisample">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2010</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glRenderbufferStorageMultisample</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glRenderbufferStorageMultisample</refname>\r
+        <refpurpose>establish data storage, format, dimensions and sample count of a renderbuffer object's image</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glRenderbufferStorageMultisample</function></funcdef>\r
+                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
+                <paramdef>GLsizei <parameter>samples</parameter></paramdef>\r
+                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>\r
+                <paramdef>GLsizei <parameter>width</parameter></paramdef>\r
+                <paramdef>GLsizei <parameter>height</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>target</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies a binding to which the target of the allocation and must be <constant>GL_RENDERBUFFER</constant>.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>samples</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the number of samples to be used for the renderbuffer object's storage.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>internalformat</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the internal format to use for the renderbuffer object's image.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>width</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the width of the renderbuffer, in pixels.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>height</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the height of the renderbuffer, in pixels.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glRenderbufferStorageMultisample</function> establishes the data storage, format, dimensions and number of\r
+            samples of a renderbuffer object's image.\r
+        </para>\r
+        <para>\r
+            The target of the operation, specified by <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.\r
+            <parameter>internalformat</parameter> specifies the internal format to be used for the renderbuffer object's storage and\r
+            must be a color-renderable, depth-renderable, or stencil-renderable format.\r
+            <parameter>width</parameter> and <parameter>height</parameter> are the dimensions, in pixels, of the renderbuffer.\r
+            Both <parameter>width</parameter> and <parameter>height</parameter> must be less than or equal to the value of\r
+            <constant>GL_MAX_RENDERBUFFER_SIZE</constant>. <parameter>samples</parameter> specifies the number of samples to be used\r
+            for the renderbuffer object's image, and must be less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.\r
+            If <parameter>internalformat</parameter> is a signed or unsigned integer format then <parameter>samples</parameter> must be\r
+            less than or equal to the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.\r
+        </para>\r
+        <para>\r
+            Upon success, <function>glRenderbufferStorageMultisample</function> deletes any existing data store for the renderbuffer\r
+            image and the contents of the data store after calling <function>glRenderbufferStorageMultisample</function> are undefined.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="errors"><title>Errors</title>\r
+        <para>\r
+            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a color-renderable, depth-renderable,\r
+            or stencil-renderable format.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format\r
+            and <parameter>samples</parameter> is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if either of <parameter>width</parameter> or <parameter>height</parameter> is negative,\r
+            or greater than the value of <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is unable to create a data store of the requested size.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDeleteRenderbuffers</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