add upstream documentation
[clinton/guile-figl.git] / upstream-man-pages / man3 / glFramebufferTextureLayer.xml
diff --git a/upstream-man-pages/man3/glFramebufferTextureLayer.xml b/upstream-man-pages/man3/glFramebufferTextureLayer.xml
new file mode 100644 (file)
index 0000000..18805ae
--- /dev/null
@@ -0,0 +1,133 @@
+<?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="glFramebufferTextureLayer">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2010</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glFramebufferTextureLayer</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glFramebufferTextureLayer</refname>\r
+        <refpurpose>attach a single layer of a texture to a framebuffer</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glFramebufferTextureLayer</function></funcdef>\r
+                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
+                <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
+                <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
+                <paramdef>GLint <parameter>level</parameter></paramdef>\r
+                <paramdef>GLint <parameter>layer</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>target</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the framebuffer target. <parameter>target</parameter> must be <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
+                    <constant>GL_READ_FRAMEBUFFER</constant>, or <constant>GL_FRAMEBUFFER</constant>. <constant>GL_FRAMEBUFFER</constant>\r
+                    is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>attachment</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the attachment point of the framebuffer. <parameter>attachment</parameter> must be\r
+                    <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant>, <constant>GL_DEPTH_ATTACHMENT</constant>,\r
+                    <constant>GL_STENCIL_ATTACHMENT</constant> or <constant>GL_DEPTH_STENCIL_ATTACHMMENT</constant>.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>texture</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the texture object to attach to the framebuffer attachment point named by <parameter>attachment</parameter>.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>level</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the mipmap level of <parameter>texture</parameter> to attach.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>layer</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the layer of <parameter>texture</parameter> to attach.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glFramebufferTextureLayer</function> operates like <citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
+            except that only a single layer of the texture level, given by <parameter>layer</parameter>, is attached to the attachment point.\r
+            If <parameter>texture</parameter> is not zero, <parameter>layer</parameter> must be greater than or equal to zero.\r
+            <parameter>texture</parameter> must either be zero or the name of an existing three-dimensional texture, one- or two-dimensional array texture,\r
+            or multisample array texture.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="notes"><title>Notes</title>\r
+        <para>\r
+            <function>glFramebufferTextureLayer</function> is available only if the GL version is 3.2 or greater.\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 one of the accepted tokens.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>attachment</parameter> is not one of the accepted tokens.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>texture</parameter> is not zero or the name of an existing\r
+            texture object.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>texture</parameter> is not zero and <parameter>layer</parameter>\r
+            is negative.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>texture</parameter> is not zero or the name of an existing cube map texture.\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>glGenRenderbuffers</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glFramebufferTextureFace</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