[clinton/guile-figl.git] / upstream-doc / man4 / glGetFramebufferParameter.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="glGetFramebufferParameter">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetFramebufferParameter</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetFramebufferParameter</refname>\r
        <refpurpose>retrieve a named parameter from a framebuffer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetFramebufferParameteriv</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLint * <parameter>params</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 retrieved.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>params</parameter></term>\r
            <listitem>\r
                <para>\r
                    The address of a variable to receive the value of 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>glGetFramebufferParameter</function> retrieves the current value of the parameter\r
            named <parameter>pname</parameter> from 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 retrieved. The values retrieved from\r
            the framebuffer are written into the variable whose address is given by <parameter>params</parameter>.\r
            The following symbols 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
                        The value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> for the framebuffer is written to the\r
                        single integer variable whose address is given by <parameter>params</parameter>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>\r
                <listitem>\r
                    <para>\r
                        The value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> for the framebuffer is written to the\r
                        single integer variable whose address is given by <parameter>params</parameter>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant></term>\r
                <listitem>\r
                    <para>\r
                        The value of <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant> for the framebuffer is written to the\r
                        single integer variable whose address is given by <parameter>params</parameter>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>\r
                <listitem>\r
                    <para>\r
                        The value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> for the framebuffer is written to the\r
                        single integer variable whose address is given by <parameter>params</parameter>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>\r
                <listitem>\r
                    <para>\r
                        If the value of <constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant> for the framebuffer is <constant>GL_TRUE</constant>\r
                        then the single integer variable whose address is in <parameter>params</parameter> is set to one,\r
                        otherwise it is set to zero.\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_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the accepted\r
            parameter names.\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
        <para>\r
            <parameter>params</parameter> should be the address of a variable to which the client has write access otherwise\r
            undefined behavior, including process termination may occur.\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>glFramebufferParameteri</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="glGetFramebufferParameter">\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>glGetFramebufferParameter</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glGetFramebufferParameter</refname>\r
	17	<refpurpose>retrieve a named parameter from a framebuffer</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glGetFramebufferParameteriv</function></funcdef>\r
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	25	<paramdef>GLint * <parameter>params</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 retrieved.\r
	45	</para>\r
	46	</listitem>\r
	47	</varlistentry>\r
	48	<varlistentry>\r
	49	<term><parameter>params</parameter></term>\r
	50	<listitem>\r
	51	<para>\r
	52	The address of a variable to receive the value of 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>glGetFramebufferParameter</function> retrieves the current value of the parameter\r
	61	named <parameter>pname</parameter> from 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 retrieved. The values retrieved from\r
69	the framebuffer are written into the variable whose address is given by <parameter>params</parameter>.\r
70	The following symbols are accepted in <parameter>pname</parameter>:\r
71	</para>\r
72	<variablelist>\r
73	<varlistentry>\r
74	<term><constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant></term>\r
75	<listitem>\r
76	<para>\r
77	The value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> for the framebuffer is written to the\r
78	single integer variable whose address is given by <parameter>params</parameter>.\r
79	</para>\r
80	</listitem>\r
81	</varlistentry>\r
82	<varlistentry>\r
83	<term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>\r
84	<listitem>\r
85	<para>\r
86	The value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> for the framebuffer is written to the\r
87	single integer variable whose address is given by <parameter>params</parameter>.\r
88	</para>\r
89	</listitem>\r
90	</varlistentry>\r
91	<varlistentry>\r
92	<term><constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant></term>\r
93	<listitem>\r
94	<para>\r
95	The value of <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant> for the framebuffer is written to the\r
96	single integer variable whose address is given by <parameter>params</parameter>.\r
97	</para>\r
98	</listitem>\r
99	</varlistentry>\r
100	<varlistentry>\r
101	<term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>\r
102	<listitem>\r
103	<para>\r
104	The value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> for the framebuffer is written to the\r
105	single integer variable whose address is given by <parameter>params</parameter>.\r
106	</para>\r
107	</listitem>\r
108	</varlistentry>\r
109	<varlistentry>\r
110	<term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>\r
111	<listitem>\r
112	<para>\r
113	If the value of <constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant> for the framebuffer is <constant>GL_TRUE</constant>\r
114	then the single integer variable whose address is in <parameter>params</parameter> is set to one,\r
115	otherwise it is set to zero.\r
116	</para>\r
117	</listitem>\r
118	</varlistentry>\r
119	</variablelist>\r
120	</refsect1>\r
121	<refsect1 id="errors"><title>Errors</title>\r
122	<para>\r
123	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted\r
124	framebuffer targets.\r
125	</para>\r
126	<para>\r
127	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the accepted\r
128	parameter names.\r
129	</para>\r
130	<para>\r
131	<constant>GL_INVALID_OPERATION</constant> is generated if the default framebuffer is bound to <parameter>target</parameter>.\r
132	</para>\r
133	<para>\r
134	<parameter>params</parameter> should be the address of a variable to which the client has write access otherwise\r
135	undefined behavior, including process termination may occur.\r
136	</para>\r
137	</refsect1>\r
138	<refsect1 id="associatedgets"><title>Associated Gets</title>\r
139	<para>\r
140	<citerefentry><refentrytitle>glGetFramebufferParameteriv</refentrytitle></citerefentry>.\r
141	</para>\r
142	</refsect1>\r
143	<refsect1 id="seealso"><title>See Also</title>\r
144	<para>\r
145	<citerefentry><refentrytitle>glFramebufferParameteri</refentrytitle></citerefentry>.\r
146	</para>\r
147	</refsect1>\r
148	<refsect1 id="Copyright"><title>Copyright</title>\r
149	<para>\r
150	Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
151	This material may be distributed subject to the terms and conditions set forth in \r
152	the Open Publication License, v 1.0, 8 June 1999.\r
153	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
154	</para>\r
155	</refsect1>\r
156	</refentry>\r