[clinton/guile-figl.git] / upstream-doc / man4 / glFramebufferParameteri.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="glFramebufferParameteri">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glFramebufferParameteri</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glFramebufferParameteri</refname>\r
        <refpurpose>set a named parameter of a framebuffer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glFramebufferParameteri</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLint <parameter>param</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
                    The target of the operation, which must be <constant>GL_READ_FRAMEBUFFER</constant>,\r
                    <constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>pname</parameter></term>\r
            <listitem>\r
                <para>\r
                    A token indicating the parameter to be modified.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>param</parameter></term>\r
            <listitem>\r
                <para>\r
                    The new value for the parameter named <parameter>pname</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glFramebufferParameteri</function> modifies the current value of the parameter\r
            named <parameter>pname</parameter> in the framebuffer bound to <parameter>target</parameter>.\r
            <parameter>target</parameter> must be <constant>GL_READ_FRAMEBFUFFER</constant>,\r
            <constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. The\r
            token <constant>GL_FRAMEBUFFER</constant> is treated as <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
            A non-default framebuffer must be bound to <parameter>target</parameter>.\r
        </para>\r
        <para>\r
            <parameter>pname</parameter> specifies the parameter to be modified. The following symbols\r
            are accepted in <parameter>pname</parameter>:\r
        </para>\r
        <variablelist>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>param</parameter> specifies the assumed with for a framebuffer object with no attachments. If a\r
                        framebuffer has attachments then the width of those attachments is used, otherwise\r
                        the value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> is used for the\r
                        framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
                        or equal to the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>param</parameter> specifies the assumed height for a framebuffer object with no attachments. If a\r
                        framebuffer has attachments then the height of those attachments is used, otherwise\r
                        the value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> is used for the\r
                        framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
                        or equal to the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>param</parameter> specifies the assumed number of layers for a framebuffer object with no attachments. If a\r
                        framebuffer has attachments then the layer count of those attachments is used, otherwise\r
                        the value of <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant> is used for the\r
                        framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
                        or equal to the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>param</parameter> specifies the assumed number of samples in a framebuffer object with no attachments. If a\r
                        framebuffer has attachments then the sample count of those attachments is used, otherwise\r
                        the value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> is used for the\r
                        framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
                        or equal to the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLE</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>param</parameter> specifies whether the framebuffer should assume identical sample locations and\r
                        the same number of samples for all texels in the virtual image. If <parameter>param</parameter> is zero,\r
                        then the implementation may vary the position or the count of samples within the virtual image from\r
                        pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
        </variablelist>\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 one of the accepted\r
            framebuffer targets.\r
        </para>\r
        <para>\r
            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant>\r
            and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant>\r
            and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant>\r
            and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant>\r
            and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLES</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if the default framebuffer is bound to <parameter>target</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGetFramebufferParameteriv</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexAttribFormat</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexBindingDivisor</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="glFramebufferParameteri">\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>glFramebufferParameteri</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glFramebufferParameteri</refname>\r
	17	<refpurpose>set a named parameter of a framebuffer</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glFramebufferParameteri</function></funcdef>\r
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	25	<paramdef>GLint <parameter>param</parameter></paramdef>\r
	26	</funcprototype>\r
	27	</funcsynopsis>\r
	28	</refsynopsisdiv>\r
	29	<refsect1 id="parameters"><title>Parameters</title>\r
	30	<variablelist>\r
	31	<varlistentry>\r
	32	<term><parameter>target</parameter></term>\r
	33	<listitem>\r
	34	<para>\r
	35	The target of the operation, which must be <constant>GL_READ_FRAMEBUFFER</constant>,\r
	36	<constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>.\r
	37	</para>\r
	38	</listitem>\r
	39	</varlistentry>\r
	40	<varlistentry>\r
	41	<term><parameter>pname</parameter></term>\r
	42	<listitem>\r
	43	<para>\r
	44	A token indicating the parameter to be modified.\r
	45	</para>\r
	46	</listitem>\r
	47	</varlistentry>\r
	48	<varlistentry>\r
	49	<term><parameter>param</parameter></term>\r
	50	<listitem>\r
	51	<para>\r
	52	The new value for the parameter named <parameter>pname</parameter>.\r
	53	</para>\r
	54	</listitem>\r
	55	</varlistentry>\r
	56	</variablelist>\r
	57	</refsect1>\r
	58	<refsect1 id="description"><title>Description</title>\r
	59	<para>\r
	60	<function>glFramebufferParameteri</function> modifies the current value of the parameter\r
	61	named <parameter>pname</parameter> in the framebuffer bound to <parameter>target</parameter>.\r
	62	<parameter>target</parameter> must be <constant>GL_READ_FRAMEBFUFFER</constant>,\r
	63	<constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. The\r
	64	token <constant>GL_FRAMEBUFFER</constant> is treated as <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
65	A non-default framebuffer must be bound to <parameter>target</parameter>.\r
66	</para>\r
67	<para>\r
68	<parameter>pname</parameter> specifies the parameter to be modified. The following symbols\r
69	are accepted in <parameter>pname</parameter>:\r
70	</para>\r
71	<variablelist>\r
72	<varlistentry>\r
73	<term><constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant></term>\r
74	<listitem>\r
75	<para>\r
76	<parameter>param</parameter> specifies the assumed with for a framebuffer object with no attachments. If a\r
77	framebuffer has attachments then the width of those attachments is used, otherwise\r
78	the value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> is used for the\r
79	framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
80	or equal to the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.\r
81	</para>\r
82	</listitem>\r
83	</varlistentry>\r
84	<varlistentry>\r
85	<term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>\r
86	<listitem>\r
87	<para>\r
88	<parameter>param</parameter> specifies the assumed height for a framebuffer object with no attachments. If a\r
89	framebuffer has attachments then the height of those attachments is used, otherwise\r
90	the value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> is used for the\r
91	framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
92	or equal to the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.\r
93	</para>\r
94	</listitem>\r
95	</varlistentry>\r
96	<varlistentry>\r
97	<term><constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant></term>\r
98	<listitem>\r
99	<para>\r
100	<parameter>param</parameter> specifies the assumed number of layers for a framebuffer object with no attachments. If a\r
101	framebuffer has attachments then the layer count of those attachments is used, otherwise\r
102	the value of <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant> is used for the\r
103	framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
104	or equal to the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.\r
105	</para>\r
106	</listitem>\r
107	</varlistentry>\r
108	<varlistentry>\r
109	<term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>\r
110	<listitem>\r
111	<para>\r
112	<parameter>param</parameter> specifies the assumed number of samples in a framebuffer object with no attachments. If a\r
113	framebuffer has attachments then the sample count of those attachments is used, otherwise\r
114	the value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> is used for the\r
115	framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than\r
116	or equal to the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLE</constant>.\r
117	</para>\r
118	</listitem>\r
119	</varlistentry>\r
120	<varlistentry>\r
121	<term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>\r
122	<listitem>\r
123	<para>\r
124	<parameter>param</parameter> specifies whether the framebuffer should assume identical sample locations and\r
125	the same number of samples for all texels in the virtual image. If <parameter>param</parameter> is zero,\r
126	then the implementation may vary the position or the count of samples within the virtual image from\r
127	pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.\r
128	</para>\r
129	</listitem>\r
130	</varlistentry>\r
131	</variablelist>\r
132	</refsect1>\r
133	<refsect1 id="errors"><title>Errors</title>\r
134	<para>\r
135	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted\r
136	framebuffer targets.\r
137	</para>\r
138	<para>\r
139	<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant>\r
140	and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.\r
141	</para>\r
142	<para>\r
143	<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant>\r
144	and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.\r
145	</para>\r
146	<para>\r
147	<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant>\r
148	and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.\r
149	</para>\r
150	<para>\r
151	<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant>\r
152	and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLES</constant>.\r
153	</para>\r
154	<para>\r
155	<constant>GL_INVALID_OPERATION</constant> is generated if the default framebuffer is bound to <parameter>target</parameter>.\r
156	</para>\r
157	</refsect1>\r
158	<refsect1 id="associatedgets"><title>Associated Gets</title>\r
159	<para>\r
160	<citerefentry><refentrytitle>glGetFramebufferParameteriv</refentrytitle></citerefentry>.\r
161	</para>\r
162	</refsect1>\r
163	<refsect1 id="seealso"><title>See Also</title>\r
164	<para>\r
165	<citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,\r
166	<citerefentry><refentrytitle>glVertexAttribFormat</refentrytitle></citerefentry>,\r
167	<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,\r
168	<citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>.\r
169	</para>\r
170	</refsect1>\r
171	<refsect1 id="Copyright"><title>Copyright</title>\r
172	<para>\r
173	Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
174	This material may be distributed subject to the terms and conditions set forth in \r
175	the Open Publication License, v 1.0, 8 June 1999.\r
176	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
177	</para>\r
178	</refsect1>\r
179	</refentry>\r