[clinton/guile-figl.git] / upstream-doc / man3 / glRenderbufferStorageMultisample.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="glRenderbufferStorageMultisample">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glRenderbufferStorageMultisample</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glRenderbufferStorageMultisample</refname>\r
        <refpurpose>establish data storage, format, dimensions and sample count of a renderbuffer object's image</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glRenderbufferStorageMultisample</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
            </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
                    Specifies a binding to which the target of the allocation and must be <constant>GL_RENDERBUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>samples</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the number of samples to be used for the renderbuffer object's storage.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>internalformat</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the internal format to use for the renderbuffer object's image.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>width</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the width of the renderbuffer, in pixels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>height</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the height of the renderbuffer, in pixels.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glRenderbufferStorageMultisample</function> establishes the data storage, format, dimensions and number of\r
            samples of a renderbuffer object's image.\r
        </para>\r
        <para>\r
            The target of the operation, specified by <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.\r
            <parameter>internalformat</parameter> specifies the internal format to be used for the renderbuffer object's storage and\r
            must be a color-renderable, depth-renderable, or stencil-renderable format.\r
            <parameter>width</parameter> and <parameter>height</parameter> are the dimensions, in pixels, of the renderbuffer.\r
            Both <parameter>width</parameter> and <parameter>height</parameter> must be less than or equal to the value of\r
            <constant>GL_MAX_RENDERBUFFER_SIZE</constant>. <parameter>samples</parameter> specifies the number of samples to be used\r
            for the renderbuffer object's image, and must be less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.\r
            If <parameter>internalformat</parameter> is a signed or unsigned integer format then <parameter>samples</parameter> must be\r
            less than or equal to the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.\r
        </para>\r
        <para>\r
            Upon success, <function>glRenderbufferStorageMultisample</function> deletes any existing data store for the renderbuffer\r
            image and the contents of the data store after calling <function>glRenderbufferStorageMultisample</function> are undefined.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a color-renderable, depth-renderable,\r
            or stencil-renderable format.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format\r
            and <parameter>samples</parameter> is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if either of <parameter>width</parameter> or <parameter>height</parameter> is negative,\r
            or greater than the value of <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is unable to create a data store of the requested size.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2010 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="glRenderbufferStorageMultisample">\r
	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2010</year>\r
	9	<holder>Khronos Group</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>glRenderbufferStorageMultisample</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glRenderbufferStorageMultisample</refname>\r
	17	<refpurpose>establish data storage, format, dimensions and sample count of a renderbuffer object's image</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glRenderbufferStorageMultisample</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	</funcprototype>\r
	29	</funcsynopsis>\r
	30	</refsynopsisdiv>\r
	31	<refsect1 id="parameters"><title>Parameters</title>\r
	32	<variablelist>\r
	33	<varlistentry>\r
	34	<term><parameter>target</parameter></term>\r
	35	<listitem>\r
	36	<para>\r
	37	Specifies a binding to which the target of the allocation and must be <constant>GL_RENDERBUFFER</constant>.\r
	38	</para>\r
	39	</listitem>\r
	40	</varlistentry>\r
	41	<varlistentry>\r
	42	<term><parameter>samples</parameter></term>\r
	43	<listitem>\r
	44	<para>\r
	45	Specifies the number of samples to be used for the renderbuffer object's storage.\r
	46	</para>\r
	47	</listitem>\r
	48	</varlistentry>\r
	49	<varlistentry>\r
	50	<term><parameter>internalformat</parameter></term>\r
	51	<listitem>\r
	52	<para>\r
	53	Specifies the internal format to use for the renderbuffer object's image.\r
	54	</para>\r
	55	</listitem>\r
	56	</varlistentry>\r
	57	<varlistentry>\r
	58	<term><parameter>width</parameter></term>\r
	59	<listitem>\r
	60	<para>\r
	61	Specifies the width of the renderbuffer, in pixels.\r
	62	</para>\r
	63	</listitem>\r
	64	</varlistentry>\r
65	<varlistentry>\r
66	<term><parameter>height</parameter></term>\r
67	<listitem>\r
68	<para>\r
69	Specifies the height of the renderbuffer, in pixels.\r
70	</para>\r
71	</listitem>\r
72	</varlistentry>\r
73	</variablelist>\r
74	</refsect1>\r
75	<refsect1 id="description"><title>Description</title>\r
76	<para>\r
77	<function>glRenderbufferStorageMultisample</function> establishes the data storage, format, dimensions and number of\r
78	samples of a renderbuffer object's image.\r
79	</para>\r
80	<para>\r
81	The target of the operation, specified by <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.\r
82	<parameter>internalformat</parameter> specifies the internal format to be used for the renderbuffer object's storage and\r
83	must be a color-renderable, depth-renderable, or stencil-renderable format.\r
84	<parameter>width</parameter> and <parameter>height</parameter> are the dimensions, in pixels, of the renderbuffer.\r
85	Both <parameter>width</parameter> and <parameter>height</parameter> must be less than or equal to the value of\r
86	<constant>GL_MAX_RENDERBUFFER_SIZE</constant>. <parameter>samples</parameter> specifies the number of samples to be used\r
87	for the renderbuffer object's image, and must be less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.\r
88	If <parameter>internalformat</parameter> is a signed or unsigned integer format then <parameter>samples</parameter> must be\r
89	less than or equal to the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.\r
90	</para>\r
91	<para>\r
92	Upon success, <function>glRenderbufferStorageMultisample</function> deletes any existing data store for the renderbuffer\r
93	image and the contents of the data store after calling <function>glRenderbufferStorageMultisample</function> are undefined.\r
94	</para>\r
95	</refsect1>\r
96	<refsect1 id="errors"><title>Errors</title>\r
97	<para>\r
98	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
99	</para>\r
100	<para>\r
101	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.\r
102	</para>\r
103	<para>\r
104	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a color-renderable, depth-renderable,\r
105	or stencil-renderable format.\r
106	</para>\r
107	<para>\r
108	<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format\r
109	and <parameter>samples</parameter> is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>\r
110	</para>\r
111	<para>\r
112	<constant>GL_INVALID_VALUE</constant> is generated if either of <parameter>width</parameter> or <parameter>height</parameter> is negative,\r
113	or greater than the value of <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.\r
114	</para>\r
115	<para>\r
116	<constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is unable to create a data store of the requested size.\r
117	</para>\r
118	</refsect1>\r
119	<refsect1 id="seealso"><title>See Also</title>\r
120	<para>\r
121	<citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
122	<citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,\r
123	<citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,\r
124	<citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r
125	<citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>\r
126	</para>\r
127	</refsect1>\r
128	<refsect1 id="Copyright"><title>Copyright</title>\r
129	<para>\r
130	Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
131	This material may be distributed subject to the terms and conditions set forth in \r
132	the Open Publication License, v 1.0, 8 June 1999.\r
133	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
134	</para>\r
135	</refsect1>\r
136	</refentry>\r