[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="glGetBufferParameteriv">\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
    </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
    </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
            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="glGetBufferParameteriv">\r
	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
	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	Specifies the target buffer object.\r
	36	The symbolic constant must be <constant>GL_ARRAY_BUFFER</constant>,\r
	37	<constant>GL_COPY_READ_BUFFER</constant>,\r
	38	<constant>GL_COPY_WRITE_BUFFER</constant>,\r
	39	<constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
	40	<constant>GL_PIXEL_PACK_BUFFER</constant>,\r
	41	<constant>GL_PIXEL_UNPACK_BUFFER</constant>,\r
	42	<constant>GL_TEXTURE_BUFFER</constant>,\r
	43	<constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or\r
	44	<constant>GL_UNIFORM_BUFFER</constant>.\r
	45	</para>\r
	46	</listitem>\r
	47	</varlistentry>\r
	48	<varlistentry>\r
	49	<term><parameter>value</parameter></term>\r
	50	<listitem>\r
	51	<para>\r
	52	Specifies the symbolic name of a buffer object parameter.\r
	53	Accepted values are <constant>GL_BUFFER_ACCESS</constant>, <constant>GL_BUFFER_MAPPED</constant>, \r
	54	<constant>GL_BUFFER_SIZE</constant>, or <constant>GL_BUFFER_USAGE</constant>.\r
	55	</para>\r
	56	</listitem>\r
	57	</varlistentry>\r
	58	<varlistentry>\r
	59	<term><parameter>data</parameter></term>\r
	60	<listitem>\r
	61	<para>\r
	62	Returns the requested parameter.\r
	63	</para>\r
	64	</listitem>\r
65	</varlistentry>\r
66	</variablelist>\r
67	</refsect1>\r
68	<refsect1 id="description"><title>Description</title>\r
69	<para>\r
70	<function>glGetBufferParameteriv</function> returns in <parameter>data</parameter> a selected parameter of the buffer object\r
71	specified by <parameter>target</parameter>.\r
72	</para>\r
73	<para>\r
74	<parameter>value</parameter> names a specific buffer object parameter, as follows:\r
75	</para>\r
76	<variablelist>\r
77	<varlistentry>\r
78	<term><constant>GL_BUFFER_ACCESS</constant></term>\r
79	<listitem>\r
80	<para>\r
81	<parameter>params</parameter> returns the access policy set while mapping the buffer object. \r
82	The initial value is <constant>GL_READ_WRITE</constant>.\r
83	</para>\r
84	</listitem>\r
85	</varlistentry>\r
86	<varlistentry>\r
87	<term><constant>GL_BUFFER_MAPPED</constant></term>\r
88	<listitem>\r
89	<para>\r
90	<parameter>params</parameter> returns a flag indicating whether the buffer object is currently \r
91	mapped. The initial value is <constant>GL_FALSE</constant>.\r
92	</para>\r
93	</listitem>\r
94	</varlistentry>\r
95	<varlistentry>\r
96	<term><constant>GL_BUFFER_SIZE</constant></term>\r
97	<listitem>\r
98	<para>\r
99	<parameter>params</parameter> returns the size of the buffer object, measured in bytes. \r
100	The initial value is 0.\r
101	</para>\r
102	</listitem>\r
103	</varlistentry>\r
104	<varlistentry>\r
105	<term><constant>GL_BUFFER_USAGE</constant></term>\r
106	<listitem>\r
107	<para>\r
108	<parameter>params</parameter> returns the buffer object's usage pattern. The initial value is\r
109	<constant>GL_STATIC_DRAW</constant>.\r
110	</para>\r
111	</listitem>\r
112	</varlistentry>\r
113	</variablelist>\r
114	</refsect1>\r
115	<refsect1 id="notes"><title>Notes</title>\r
116	<para>\r
117	If an error is generated,\r
118	no change is made to the contents of <parameter>data</parameter>.\r
119	</para>\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> or <parameter>value</parameter> is not an\r
124	accepted value.\r
125	</para>\r
126	<para>\r
127	<constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.\r
128	</para>\r
129	</refsect1>\r
130	<refsect1 id="seealso"><title>See Also</title>\r
131	<para>\r
132	<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
133	<citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,\r
134	<citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,\r
135	<citerefentry><refentrytitle>glUnmapBuffer</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> 2005 Addison-Wesley. \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