Opentk/Source/Bind/Specifications/Docs/glShaderStorageBlockBinding.xml
2013-12-15 22:32:32 +01:00

100 lines
5.1 KiB
XML

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