[clinton/guile-figl.git] / upstream-doc / man4 / glTexImage3DMultisample.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="glTexImage3DMultisample">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2010</year>
                <holder>Khronos Group</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glTexImage3DMultisample</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glTexImage3DMultisample</refname>
        <refpurpose>establish the data storage, format, dimensions, and number of samples of a multisample texture's image</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glTexImage3DMultisample</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLsizei <parameter>samples</parameter></paramdef>
                <paramdef>GLint <parameter>internalformat</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLsizei <parameter>height</parameter></paramdef>
                <paramdef>GLsizei <parameter>depth</parameter></paramdef>
                <paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specifies the target of the operation. <parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>samples</parameter></term>
            <listitem>
                <para>
                    The number of samples in the multisample texture's image.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>internalformat</parameter></term>
            <listitem>
                <para>
                    The internal format to be used to store the multisample texture's image. <parameter>internalformat</parameter> must specify a color-renderable, depth-renderable, or stencil-renderable format.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    The width of the multisample texture's image, in texels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>height</parameter></term>
            <listitem>
                <para>
                    The height of the multisample texture's image, in texels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>fixedsamplelocations</parameter></term>
            <listitem>
                <para>
                    Specifies whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not
                    depend on the internal format or size of the image.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glTexImage3DMultisample</function> establishes the data storage, format, dimensions and number of samples of a multisample texture's image.
        </para>
        <para>
            <parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>.
            <parameter>width</parameter> and <parameter>height</parameter>are the dimensions in texels of the texture, and must
            be in the range zero to <constant>GL_MAX_TEXTURE_SIZE</constant> - 1. <parameter>depth</parameter> is the number of array slices in the array texture's image.
            <parameter>samples</parameter> specifies the number of samples in the image and must be in the range zero to <constant>GL_MAX_SAMPLES</constant> - 1.
        </para>
        <para>
            <parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.
        </para>
        <para>
            If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>, the image will use identical sample locations and the same
            number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image.
        </para>
        <para>
            When a multisample texture is accessed in a shader, the access takes one vector of integers describing which texel to fetch and an integer
            corresponding to the sample numbers describing which sample within the texel to fetch. No standard sampling instructions are allowed on the
            multisample texture targets.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <function>glTexImage2DMultisample</function> is available only if the GL version is 3.2 or greater.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a depth- or stencil-renderable format and <parameter>samples</parameter>
            is greater than the value of <constant>GL_MAX_DEPTH_TEXTURE_SAMPLES</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a color-renderable format and <parameter>samples</parameter> is
            greater than the value of <constant>GL_MAX_COLOR_TEXTURE_SAMPLES</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format and <parameter>samples</parameter>
            is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if either <parameter>width</parameter> or <parameter>height</parameter> negative or is greater than <constant>GL_MAX_TEXTURE_SIZE</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>depth</parameter> is negative or is greater than <constant>GL_MAX_ARRAY_TEXTURE_LAYERS</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2010 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>
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
	4	<refentry id="glTexImage3DMultisample">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>2010</year>
	9	<holder>Khronos Group</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glTexImage3DMultisample</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glTexImage3DMultisample</refname>
	17	<refpurpose>establish the data storage, format, dimensions, and number of samples of a multisample texture's image</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glTexImage3DMultisample</function></funcdef>
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>
	24	<paramdef>GLsizei <parameter>samples</parameter></paramdef>
	25	<paramdef>GLint <parameter>internalformat</parameter></paramdef>
	26	<paramdef>GLsizei <parameter>width</parameter></paramdef>
	27	<paramdef>GLsizei <parameter>height</parameter></paramdef>
	28	<paramdef>GLsizei <parameter>depth</parameter></paramdef>
	29	<paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>
	30	</funcprototype>
	31	</funcsynopsis>
	32	</refsynopsisdiv>
	33	<refsect1 id="parameters"><title>Parameters</title>
	34	<variablelist>
	35	<varlistentry>
	36	<term><parameter>target</parameter></term>
	37	<listitem>
	38	<para>
	39	Specifies the target of the operation. <parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>.
	40	</para>
	41	</listitem>
	42	</varlistentry>
	43	<varlistentry>
	44	<term><parameter>samples</parameter></term>
	45	<listitem>
	46	<para>
	47	The number of samples in the multisample texture's image.
	48	</para>
	49	</listitem>
	50	</varlistentry>
	51	<varlistentry>
	52	<term><parameter>internalformat</parameter></term>
	53	<listitem>
	54	<para>
	55	The internal format to be used to store the multisample texture's image. <parameter>internalformat</parameter> must specify a color-renderable, depth-renderable, or stencil-renderable format.
	56	</para>
	57	</listitem>
	58	</varlistentry>
	59	<varlistentry>
	60	<term><parameter>width</parameter></term>
	61	<listitem>
	62	<para>
	63	The width of the multisample texture's image, in texels.
	64	</para>
65	</listitem>
66	</varlistentry>
67	<varlistentry>
68	<term><parameter>height</parameter></term>
69	<listitem>
70	<para>
71	The height of the multisample texture's image, in texels.
72	</para>
73	</listitem>
74	</varlistentry>
75	<varlistentry>
76	<term><parameter>fixedsamplelocations</parameter></term>
77	<listitem>
78	<para>
79	Specifies whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not
80	depend on the internal format or size of the image.
81	</para>
82	</listitem>
83	</varlistentry>
84	</variablelist>
85	</refsect1>
86	<refsect1 id="description"><title>Description</title>
87	<para>
88	<function>glTexImage3DMultisample</function> establishes the data storage, format, dimensions and number of samples of a multisample texture's image.
89	</para>
90	<para>
91	<parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>.
92	<parameter>width</parameter> and <parameter>height</parameter>are the dimensions in texels of the texture, and must
93	be in the range zero to <constant>GL_MAX_TEXTURE_SIZE</constant> - 1. <parameter>depth</parameter> is the number of array slices in the array texture's image.
94	<parameter>samples</parameter> specifies the number of samples in the image and must be in the range zero to <constant>GL_MAX_SAMPLES</constant> - 1.
95	</para>
96	<para>
97	<parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.
98	</para>
99	<para>
100	If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>, the image will use identical sample locations and the same
101	number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image.
102	</para>
103	<para>
104	When a multisample texture is accessed in a shader, the access takes one vector of integers describing which texel to fetch and an integer
105	corresponding to the sample numbers describing which sample within the texel to fetch. No standard sampling instructions are allowed on the
106	multisample texture targets.
107	</para>
108	</refsect1>
109	<refsect1 id="notes"><title>Notes</title>
110	<para>
111	<function>glTexImage2DMultisample</function> is available only if the GL version is 3.2 or greater.
112	</para>
113	</refsect1>
114	<refsect1 id="errors"><title>Errors</title>
115	<para>
116	<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a depth- or stencil-renderable format and <parameter>samples</parameter>
117	is greater than the value of <constant>GL_MAX_DEPTH_TEXTURE_SAMPLES</constant>.
118	</para>
119	<para>
120	<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a color-renderable format and <parameter>samples</parameter> is
121	greater than the value of <constant>GL_MAX_COLOR_TEXTURE_SAMPLES</constant>.
122	</para>
123	<para>
124	<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format and <parameter>samples</parameter>
125	is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.
126	</para>
127	<para>
128	<constant>GL_INVALID_VALUE</constant> is generated if either <parameter>width</parameter> or <parameter>height</parameter> negative or is greater than <constant>GL_MAX_TEXTURE_SIZE</constant>.
129	</para>
130	<para>
131	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>depth</parameter> is negative or is greater than <constant>GL_MAX_ARRAY_TEXTURE_LAYERS</constant>.
132	</para>
133	<para>
134	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.
135	</para>
136	</refsect1>
137	<refsect1 id="seealso"><title>See Also</title>
138	<para>
139	<citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
140	<citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>
141	</para>
142	</refsect1>
143	<refsect1 id="Copyright"><title>Copyright</title>
144	<para>
145	Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
146	This material may be distributed subject to the terms and conditions set forth in
147	the Open Publication License, v 1.0, 8 June 1999.
148	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
149	</para>
150	</refsect1>
151	</refentry>