[clinton/guile-figl.git] / upstream-doc / man3 / glGetBufferParameter.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="glGetBufferParameter">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2005</year>\r
                <holder>Sams Publishing</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetBufferParameteriv</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetBufferParameteriv</refname>\r
        <refpurpose>return parameters of a buffer object</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetBufferParameteriv</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>value</parameter></paramdef>\r
                <paramdef>GLint * <parameter>data</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetBufferParameteri64v</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>value</parameter></paramdef>\r
                <paramdef>GLint64 * <parameter>data</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 the target buffer object.\r
                    The symbolic constant must be <constant>GL_ARRAY_BUFFER</constant>,\r
                    <constant>GL_COPY_READ_BUFFER</constant>,\r
                    <constant>GL_COPY_WRITE_BUFFER</constant>,\r
                    <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
                    <constant>GL_PIXEL_PACK_BUFFER</constant>,\r
                    <constant>GL_PIXEL_UNPACK_BUFFER</constant>,\r
                    <constant>GL_TEXTURE_BUFFER</constant>,\r
                    <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or\r
                    <constant>GL_UNIFORM_BUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>value</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the symbolic name of a buffer object parameter.\r
                    Accepted values are <constant>GL_BUFFER_ACCESS</constant>, <constant>GL_BUFFER_MAPPED</constant>, \r
                    <constant>GL_BUFFER_SIZE</constant>, or <constant>GL_BUFFER_USAGE</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>data</parameter></term>\r
            <listitem>\r
                <para>\r
                    Returns the requested parameter.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glGetBufferParameteriv</function> returns in <parameter>data</parameter> a selected parameter of the buffer object\r
            specified by <parameter>target</parameter>.\r
        </para>\r
        <para>\r
            <parameter>value</parameter> names a specific buffer object parameter, as follows:\r
        </para>\r
        <variablelist>\r
            <varlistentry>\r
                <term><constant>GL_BUFFER_ACCESS</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>params</parameter> returns the access policy set while mapping the buffer object.  \r
                        The initial value is <constant>GL_READ_WRITE</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_BUFFER_MAPPED</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>params</parameter> returns a flag indicating whether the buffer object is currently \r
                        mapped. The initial value is <constant>GL_FALSE</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_BUFFER_SIZE</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>params</parameter> returns the size of the buffer object, measured in bytes.  \r
                        The initial value is 0.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_BUFFER_USAGE</constant></term>\r
                <listitem>\r
                    <para>\r
                        <parameter>params</parameter> returns the buffer object's usage pattern.  The initial value is\r
                        <constant>GL_STATIC_DRAW</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            If an error is generated,\r
            no change is made to the contents of <parameter>data</parameter>.\r
        </para>\r
        <para>\r
            <function>glGetBufferParameteri64v</function> is available only if the GL version is 3.2 or higher.\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> or <parameter>value</parameter> is not an\r
            accepted value.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley. \r
            Copyright <trademark class="copyright"></trademark> 2010-2013 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
c7b31271	4	<refentry id="glGetBufferParameter">\r
7faf1d71 AW	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2005</year>\r
	9	<holder>Sams Publishing</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>glGetBufferParameteriv</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glGetBufferParameteriv</refname>\r
	17	<refpurpose>return parameters of a buffer object</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glGetBufferParameteriv</function></funcdef>\r
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>value</parameter></paramdef>\r
	25	<paramdef>GLint * <parameter>data</parameter></paramdef>\r
	26	</funcprototype>\r
	27	</funcsynopsis>\r
c7b31271 DH	28	<funcsynopsis>\r
	29	<funcprototype>\r
	30	<funcdef>void <function>glGetBufferParameteri64v</function></funcdef>\r
	31	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	32	<paramdef>GLenum <parameter>value</parameter></paramdef>\r
	33	<paramdef>GLint64 * <parameter>data</parameter></paramdef>\r
	34	</funcprototype>\r
	35	</funcsynopsis>\r
7faf1d71 AW	36	</refsynopsisdiv>\r
	37	<refsect1 id="parameters"><title>Parameters</title>\r
	38	<variablelist>\r
	39	<varlistentry>\r
	40	<term><parameter>target</parameter></term>\r
	41	<listitem>\r
	42	<para>\r
	43	Specifies the target buffer object.\r
	44	The symbolic constant must be <constant>GL_ARRAY_BUFFER</constant>,\r
	45	<constant>GL_COPY_READ_BUFFER</constant>,\r
	46	<constant>GL_COPY_WRITE_BUFFER</constant>,\r
	47	<constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
	48	<constant>GL_PIXEL_PACK_BUFFER</constant>,\r
	49	<constant>GL_PIXEL_UNPACK_BUFFER</constant>,\r
	50	<constant>GL_TEXTURE_BUFFER</constant>,\r
	51	<constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or\r
	52	<constant>GL_UNIFORM_BUFFER</constant>.\r
	53	</para>\r
	54	</listitem>\r
	55	</varlistentry>\r
	56	<varlistentry>\r
	57	<term><parameter>value</parameter></term>\r
	58	<listitem>\r
	59	<para>\r
	60	Specifies the symbolic name of a buffer object parameter.\r
	61	Accepted values are <constant>GL_BUFFER_ACCESS</constant>, <constant>GL_BUFFER_MAPPED</constant>, \r
	62	<constant>GL_BUFFER_SIZE</constant>, or <constant>GL_BUFFER_USAGE</constant>.\r
	63	</para>\r
	64	</listitem>\r
	65	</varlistentry>\r
	66	<varlistentry>\r
	67	<term><parameter>data</parameter></term>\r
	68	<listitem>\r
	69	<para>\r
	70	Returns the requested parameter.\r
	71	</para>\r
	72	</listitem>\r
	73	</varlistentry>\r
	74	</variablelist>\r
	75	</refsect1>\r
	76	<refsect1 id="description"><title>Description</title>\r
	77	<para>\r
	78	<function>glGetBufferParameteriv</function> returns in <parameter>data</parameter> a selected parameter of the buffer object\r
	79	specified by <parameter>target</parameter>.\r
	80	</para>\r
	81	<para>\r
	82	<parameter>value</parameter> names a specific buffer object parameter, as follows:\r
	83	</para>\r
	84	<variablelist>\r
	85	<varlistentry>\r
	86	<term><constant>GL_BUFFER_ACCESS</constant></term>\r
	87	<listitem>\r
	88	<para>\r
	89	<parameter>params</parameter> returns the access policy set while mapping the buffer object. \r
	90	The initial value is <constant>GL_READ_WRITE</constant>.\r
	91	</para>\r
	92	</listitem>\r
	93	</varlistentry>\r
	94	<varlistentry>\r
	95	<term><constant>GL_BUFFER_MAPPED</constant></term>\r
	96	<listitem>\r
	97	<para>\r
	98	<parameter>params</parameter> returns a flag indicating whether the buffer object is currently \r
	99	mapped. The initial value is <constant>GL_FALSE</constant>.\r
100	</para>\r
101	</listitem>\r
102	</varlistentry>\r
103	<varlistentry>\r
104	<term><constant>GL_BUFFER_SIZE</constant></term>\r
105	<listitem>\r
106	<para>\r
107	<parameter>params</parameter> returns the size of the buffer object, measured in bytes. \r
108	The initial value is 0.\r
109	</para>\r
110	</listitem>\r
111	</varlistentry>\r
112	<varlistentry>\r
113	<term><constant>GL_BUFFER_USAGE</constant></term>\r
114	<listitem>\r
115	<para>\r
116	<parameter>params</parameter> returns the buffer object's usage pattern. The initial value is\r
117	<constant>GL_STATIC_DRAW</constant>.\r
118	</para>\r
119	</listitem>\r
120	</varlistentry>\r
121	</variablelist>\r
122	</refsect1>\r
123	<refsect1 id="notes"><title>Notes</title>\r
124	<para>\r
125	If an error is generated,\r
126	no change is made to the contents of <parameter>data</parameter>.\r
127	</para>\r
c7b31271 DH	128	<para>\r
	129	<function>glGetBufferParameteri64v</function> is available only if the GL version is 3.2 or higher.\r
	130	</para>\r
7faf1d71 AW	131	</refsect1>\r
	132	<refsect1 id="errors"><title>Errors</title>\r
	133	<para>\r
	134	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>value</parameter> is not an\r
	135	accepted value.\r
	136	</para>\r
	137	<para>\r
	138	<constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.\r
	139	</para>\r
	140	</refsect1>\r
	141	<refsect1 id="seealso"><title>See Also</title>\r
	142	<para>\r
	143	<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
	144	<citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,\r
	145	<citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,\r
	146	<citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>\r
	147	</para>\r
	148	</refsect1>\r
	149	<refsect1 id="Copyright"><title>Copyright</title>\r
	150	<para>\r
	151	Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley. \r
c7b31271	152	Copyright <trademark class="copyright"></trademark> 2010-2013 Khronos Group. \r
7faf1d71 AW	153	This material may be distributed subject to the terms and conditions set forth in \r
	154	the Open Publication License, v 1.0, 8 June 1999.\r
	155	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
	156	</para>\r
	157	</refsect1>\r
	158	</refentry>\r