[clinton/guile-figl.git] / upstream-doc / man4 / glTexStorage2DMultisample.xml

<?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="glTexStorage2DMultisample">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glTexStorage2DMultisample</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glTexStorage2DMultisample</refname>\r
        <refpurpose>specify storage for a two-dimensional multisample texture</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glTexStorage2DMultisample</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>samples</parameter></paramdef>\r
                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>width</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>height</parameter></paramdef>\r
                <paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>target</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the target of the operation. <parameter>target</parameter> must be\r
                    <constant>GL_TEXTURE_2D_MULTISAMPLE</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>samples</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the number of samples in the texture.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>internalformat</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the sized internal format to be used to store texture image data.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>width</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the width of the texture, in texels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>height</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the height of the texture, in texels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>fixedsamplelocations</parameter></term>\r
            <listitem>\r
                <para>\r
                    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\r
                    depend on the internal format or size of the image.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glTexStorage2DMultisample</function> specifies the storage requirements for\r
            a two-dimensional multisample texture. Once a texture is specified with this\r
            command, its format and dimensions become immutable unless it is a proxy\r
            texture. The contents of the image may still be modified, however, its storage requirements\r
            may not change. Such a texture is referred to as an <emphasis>immutable-format</emphasis>\r
            texture.\r
        </para>\r
        <para>\r
            <parameter>samples</parameter> specifies the number of samples to be used for the texture\r
            and must be greater than zero and less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.\r
            <parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.\r
            <parameter>width</parameter> and <parameter>height</parameter> specify the width and height,\r
            respectively, of the texture. If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>,\r
            the image will use identical sample locations and the same number of samples for all texels in the image,\r
            and the sample locations will not depend on the internal format or size of the image.\r
        </para>\r
        <para>\r
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="internalformattable.xml" />\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a\r
            valid color-renderable, depth-renderable or stencil-renderable format.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not\r
            one of the accepted target enumerants.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> or <parameter>height</parameter>\r
            are less than 1 or greater than the value of <constant>GL_MAX_TEXTURE_SIZE</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than the\r
            value of <constant>GL_MAX_SAMPLES</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if the value of <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant>\r
            for the texture bound to <parameter>target</parameter> is not <constant>GL_FALSE</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glTexStorage1D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glTexStorage3D</refentrytitle></citerefentry>.\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
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>\r
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
	4	<refentry id="glTexStorage2DMultisample">\r
	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2012</year>\r
	9	<holder>Khronos Group</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>glTexStorage2DMultisample</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glTexStorage2DMultisample</refname>\r
	17	<refpurpose>specify storage for a two-dimensional multisample texture</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glTexStorage2DMultisample</function></funcdef>\r
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	24	<paramdef>GLsizei <parameter>samples</parameter></paramdef>\r
	25	<paramdef>GLenum <parameter>internalformat</parameter></paramdef>\r
	26	<paramdef>GLsizei <parameter>width</parameter></paramdef>\r
	27	<paramdef>GLsizei <parameter>height</parameter></paramdef>\r
	28	<paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>\r
	29	</funcprototype>\r
	30	</funcsynopsis>\r
	31	</refsynopsisdiv>\r
	32	<refsect1 id="parameters"><title>Parameters</title>\r
	33	<variablelist>\r
	34	<varlistentry>\r
	35	<term><parameter>target</parameter></term>\r
	36	<listitem>\r
	37	<para>\r
	38	Specify the target of the operation. <parameter>target</parameter> must be\r
	39	<constant>GL_TEXTURE_2D_MULTISAMPLE</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE</constant>.\r
	40	</para>\r
	41	</listitem>\r
	42	</varlistentry>\r
	43	<varlistentry>\r
	44	<term><parameter>samples</parameter></term>\r
	45	<listitem>\r
	46	<para>\r
	47	Specify the number of samples in the texture.\r
	48	</para>\r
	49	</listitem>\r
	50	</varlistentry>\r
	51	<varlistentry>\r
	52	<term><parameter>internalformat</parameter></term>\r
	53	<listitem>\r
	54	<para>\r
	55	Specifies the sized internal format to be used to store texture image data.\r
	56	</para>\r
	57	</listitem>\r
	58	</varlistentry>\r
	59	<varlistentry>\r
	60	<term><parameter>width</parameter></term>\r
	61	<listitem>\r
	62	<para>\r
	63	Specifies the width of the texture, in texels.\r
	64	</para>\r
65	</listitem>\r
66	</varlistentry>\r
67	<varlistentry>\r
68	<term><parameter>height</parameter></term>\r
69	<listitem>\r
70	<para>\r
71	Specifies the height of the texture, in texels.\r
72	</para>\r
73	</listitem>\r
74	</varlistentry>\r
75	<varlistentry>\r
76	<term><parameter>fixedsamplelocations</parameter></term>\r
77	<listitem>\r
78	<para>\r
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\r
80	depend on the internal format or size of the image.\r
81	</para>\r
82	</listitem>\r
83	</varlistentry>\r
84	</variablelist>\r
85	</refsect1>\r
86	<refsect1 id="description"><title>Description</title>\r
87	<para>\r
88	<function>glTexStorage2DMultisample</function> specifies the storage requirements for\r
89	a two-dimensional multisample texture. Once a texture is specified with this\r
90	command, its format and dimensions become immutable unless it is a proxy\r
91	texture. The contents of the image may still be modified, however, its storage requirements\r
92	may not change. Such a texture is referred to as an <emphasis>immutable-format</emphasis>\r
93	texture.\r
94	</para>\r
95	<para>\r
96	<parameter>samples</parameter> specifies the number of samples to be used for the texture\r
97	and must be greater than zero and less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.\r
98	<parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.\r
99	<parameter>width</parameter> and <parameter>height</parameter> specify the width and height,\r
100	respectively, of the texture. If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>,\r
101	the image will use identical sample locations and the same number of samples for all texels in the image,\r
102	and the sample locations will not depend on the internal format or size of the image.\r
103	</para>\r
104	<para>\r
105	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="internalformattable.xml" />\r
106	</para>\r
107	</refsect1>\r
108	<refsect1 id="errors"><title>Errors</title>\r
109	<para>\r
110	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a\r
111	valid color-renderable, depth-renderable or stencil-renderable format.\r
112	</para>\r
113	<para>\r
114	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not\r
115	one of the accepted target enumerants.\r
116	</para>\r
117	<para>\r
118	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> or <parameter>height</parameter>\r
119	are less than 1 or greater than the value of <constant>GL_MAX_TEXTURE_SIZE</constant>.\r
120	</para>\r
121	<para>\r
122	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than the\r
123	value of <constant>GL_MAX_SAMPLES</constant>.\r
124	</para>\r
125	<para>\r
126	<constant>GL_INVALID_OPERATION</constant> is generated if the value of <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant>\r
127	for the texture bound to <parameter>target</parameter> is not <constant>GL_FALSE</constant>.\r
128	</para>\r
129	</refsect1>\r
130	<refsect1 id="seealso"><title>See Also</title>\r
131	<para>\r
132	<citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,\r
133	<citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>,\r
134	<citerefentry><refentrytitle>glTexStorage1D</refentrytitle></citerefentry>,\r
135	<citerefentry><refentrytitle>glTexStorage3D</refentrytitle></citerefentry>.\r
136	</para>\r
137	</refsect1>\r
138	<refsect1 id="Copyright"><title>Copyright</title>\r
139	<para>\r
140	Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
141	This material may be distributed subject to the terms and conditions set forth in \r
142	the Open Publication License, v 1.0, 8 June 1999.\r
143	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
144	</para>\r
145	</refsect1>\r
146	</refentry>\r