add upstream documentation

[clinton/guile-figl.git] / upstream-man-pages / man4 / glShaderStorageBlockBinding.xml

diff --git a/upstream-man-pages/man4/glShaderStorageBlockBinding.xml b/upstream-man-pages/man4/glShaderStorageBlockBinding.xml
new file mode 100644 (file)
index 0000000..deb57b1
--- /dev/null
+++ b/upstream-man-pages/man4/glShaderStorageBlockBinding.xml
@@ -0,0 +1,99 @@
+<?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="glShaderStorageBlockBinding">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2012</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glShaderStorageBlockBinding</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glShaderStorageBlockBinding</refname>\r
+        <refpurpose>change an active shader storage block binding</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glShaderStorageBlockBinding</function></funcdef>\r
+                <paramdef>GLuint <parameter>program</parameter></paramdef>\r
+                <paramdef>GLuint <parameter>storageBlockIndex</parameter></paramdef>\r
+                <paramdef>GLuint <parameter>storageBlockBinding</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>program</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The name of the program containing the block whose binding to change.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>storageBlockIndex</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The index storage block within the program.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>storageBlockBinding</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The index storage block binding to associate with the specified storage block.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glShaderStorageBlockBinding</function>, changes the active\r
+            shader storage block with an assigned index of <parameter>storageBlockIndex</parameter>\r
+            in program object <parameter>program</parameter>.  <parameter>storageBlockIndex</parameter> must be an active shader storage block\r
+            index in <parameter>program</parameter>. <parameter>storageBlockBinding</parameter> must be less than the value of <constant>GL_MAX_SHADER_STORAGE_BUFFER_BINDINGS</constant>.\r
+            If successful, <function>glShaderStorageBinding</function> specifies that <parameter>program</parameter> will use the data store of\r
+            the buffer object bound to the binding point <parameter>storageBlockBinding</parameter> to read\r
+            and write the values of the buffer variables in the shader storage block identified by <parameter>storageBlockIndex</parameter>.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="errors"><title>Errors</title>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>attribindex</parameter> is greater than\r
+            or equal to the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than\r
+            or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with arguments <constant>GL_SHADER_STORAGE_BUFFER_BINDING</constant>,\r
+            <constant>GL_MAX_SHADER_STORAGE_BUFFER_BINDINGS</constant>, <constant>GL_MAX_VERTEX_SHADER_STORAGE_BLOCKS</constant>,\r
+            <constant>GL_MAX_TESS_CONTROL_SHADER_STORAGE_BLOCKS</constant>, <constant>GL_MAX_TESS_EVALUATION_SHADER_STORAGE_BLOCKS</constant>,\r
+            <constant>GL_MAX_GEOMETRY_SHADER_STORAGE_BLOCKS</constant>, <constant>GL_MAX_FRAGMENT_SHADER_STORAGE_BLOCKS</constant>,\r
+            <constant>GL_MAX_COMPUTE_SHADER_STORAGE_BLOCKS</constant> or <constant>GL_MAX_COMBINED_SHADER_STORAGE_BLOCKS</constant>,\r
+            <constant>GL_MAX_SHADER_STORAGE_BUFFER_BINDINGS</constant>, or <constant>GL_MAX_COMBINED_SHADER_OUTPUT_RESOURCES</constant>.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2012 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