mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 05:55:27 +00:00
161 lines
8.6 KiB
XML
161 lines
8.6 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="glBindImageTextures">
|
|
<refentryinfo>
|
|
<copyright>
|
|
<year>2013</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>glBindImageTextures</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glBindImageTextures</refname>
|
|
<refpurpose>bind one or more named texture images to a sequence of consecutive image units</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glBindImageTextures</function></funcdef>
|
|
<paramdef>GLuint <parameter>first</parameter></paramdef>
|
|
<paramdef>GLsizei <parameter>count</parameter></paramdef>
|
|
<paramdef>const GLuint *<parameter>textures</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>first</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the first image unit to which a texture is to be bound.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>count</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the number of textures to bind.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>textures</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the address of an array of names of existing texture objects.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glBindImageTextures</function> binds images from an array of existing texture objects to a specified
|
|
number of consecutive image units. <parameter>count</parameter> specifies the number of texture
|
|
objects whose names are stored in the array <parameter>textures</parameter>. That number
|
|
of texture names are read from the array and bound to the <parameter>count</parameter> consecutive
|
|
texture units starting from <parameter>first</parameter>.
|
|
|
|
If the name zero appears in the <parameter>textures</parameter> array, any existing binding
|
|
to the image unit is reset. Any non-zero entry in <parameter>textures</parameter> must be the
|
|
name of an existing texture object. When a non-zero entry in <parameter>textures</parameter> is
|
|
present, the image at level zero is bound, the binding is considered layered, with the first
|
|
layer set to zero, and the image is bound for read-write access. The image unit format
|
|
parameter is taken from the internal format of the image at level zero of the texture object.
|
|
For cube map textures, the internal format of the positive X image of level zero is used.
|
|
|
|
|
|
If <parameter>textures</parameter> is <constant>NULL</constant> then it is as
|
|
if an appropriately sized array containing only zeros had been specified.
|
|
</para>
|
|
<para>
|
|
<function>glBindImageTextures</function> is equivalent to the following pseudo code:
|
|
</para>
|
|
<programlisting><![CDATA[ for (i = 0; i < count; i++) {
|
|
if (textures == NULL || textures[i] = 0) {
|
|
glBindImageTexture(first + i, 0, 0, GL_FALSE, 0, GL_READ_ONLY, GL_R8);
|
|
} else {
|
|
glBindImageTexture(first + i, textures[i], 0, GL_TRUE, 0, GL_READ_WRITE, lookupInternalFormat(textures[i]));
|
|
}
|
|
}]]></programlisting>
|
|
<para>
|
|
Each entry in <parameter>textures</parameter> will be checked individually and if found
|
|
to be invalid, the state for that image unit will not be changed and an error will be
|
|
generated. However, the state for other texture image units referenced by the command will still
|
|
be updated.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>
|
|
<function>glBindImageTextures</function> is available only if the GL version is 4.4 or higher.
|
|
</para>
|
|
<para>
|
|
Note that because <function>glBindImageTextures</function> cannot create new textures (even if
|
|
a name passed has been previously generated by call to <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>),
|
|
names pased to <function>glBindTextures</function> must have been bound at least once previously
|
|
via a call to <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>first</parameter> + <parameter>count</parameter> is greater
|
|
than the number of image units supported by the implementation.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if any value in <parameter>textures</parameter> is
|
|
not zero or the name of an existing texture object.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> error is generated if the internal format of the
|
|
level zero texture image of any texture in textures is not supported.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> error is generated if the width, height, or depth
|
|
of the level zero texture image of any texture in textures is zero.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_BINDING_1D</constant>,
|
|
<constant>GL_TEXTURE_BINDING_2D</constant>, <constant>GL_TEXTURE_BINDING_3D</constant>, <constant>GL_TEXTURE_BINDING_1D_ARRAY</constant>,
|
|
<constant>GL_TEXTURE_BINDING_2D_ARRAY</constant>, <constant>GL_TEXTURE_BINDING_RECTANGLE</constant>,
|
|
<constant>GL_TEXTURE_BINDING_BUFFER</constant>, <constant>GL_TEXTURE_BINDING_CUBE_MAP</constant>, <constant>GL_TEXTURE_BINDING_CUBE_MAP</constant>,
|
|
<constant>GL_TEXTURE_BINDING_CUBE_MAP_ARRAY</constant>,
|
|
<constant>GL_TEXTURE_BINDING_2D_MULTISAMPLE</constant>,
|
|
or <constant>GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</constant>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glBindTextures</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glIsTexture</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexStorage1D</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexStorage2D</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexStorage2DMultisample</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexStorage3D</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexStorage3DMultisample</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexBuffer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
|
|
</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>
|