[clinton/guile-figl.git] / upstream-doc / man3 / glCopyBufferSubData.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="glCopyBufferSubData">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glCopyBufferSubData</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glCopyBufferSubData</refname>\r
        <refpurpose>copy part of the data store of a buffer object to the data store of another buffer object</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glCopyBufferSubData</function></funcdef>\r
                <paramdef>GLenum <parameter>readtarget</parameter></paramdef>\r
                <paramdef>GLenum <parameter>writetarget</parameter></paramdef>\r
                <paramdef>GLintptr <parameter>readoffset</parameter></paramdef>\r
                <paramdef>GLintptr <parameter>writeoffset</parameter></paramdef>\r
                <paramdef>GLsizeiptr <parameter>size</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <!-- eqn: ignoring delim $$ -->\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>readtarget</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the target from whose data store data should be read.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>writetarget</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the target to whose data store data should be written.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>readoffset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the offset, in basic machine units, within the data store of <parameter>readtarget</parameter> from which data should be read.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>writeoffset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the offset, in basic machine units, within the data store of <parameter>writetarget</parameter> to which data should be written.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>size</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the size, in basic machine units, of the data to be copied from <parameter>readtarget</parameter> to <parameter>writetarget</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glCopyBufferSubData</function> copies part of the data store attached to <parameter>readtarget</parameter> to the\r
            data store attached to <parameter>writetarget</parameter>. The number of basic machine units indicated by <parameter>size</parameter>\r
            is copied from the source, at offset <parameter>readoffset</parameter> to the destination at <parameter>writeoffset</parameter>,\r
            also in basic machine units.\r
        </para>\r
        <para>\r
            <parameter>readtarget</parameter> and <parameter>writetarget</parameter> must be <constant>GL_ARRAY_BUFFER</constant>,\r
            <constant>GL_COPY_READ_BUFFER</constant>, <constant>GL_COPY_WRITE_BUFFER</constant>, <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
            <constant>GL_PIXEL_PACK_BUFFER</constant>, <constant>GL_PIXEL_UNPACK_BUFFER</constant>, <constant>GL_TEXTURE_BUFFER</constant>,\r
            <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>. Any of these targets may be used,\r
            although the targets <constant>GL_COPY_READ_BUFFER</constant> and <constant>GL_COPY_WRITE_BUFFER</constant> are provided\r
            specifically to allow copies between buffers without disturbing other GL state.\r
        </para>\r
        <para>\r
            <parameter>readoffset</parameter>, <parameter>writeoffset</parameter> and <parameter>size</parameter> must all be greater than or equal to\r
            zero. Furthermore, <parameter>readoffset</parameter> + <parameter>size</parameter> must not exceeed the size of the buffer\r
            object bound to <parameter>readtarget</parameter>, and <parameter>readoffset</parameter> + <parameter>size</parameter> must not exceeed the\r
            size of the buffer bound to <parameter>writetarget</parameter>. If the same buffer object is bound to both <parameter>readtarget</parameter>\r
            and <parameter>writetarget</parameter>, then the ranges specified by <parameter>readoffset</parameter>, <parameter>writeoffset</parameter>\r
            and <parameter>size</parameter> must not overlap.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
           <function>glCopyBufferSubData</function> is available only if the GL version is 3.1 or greater.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if any of <parameter>readoffset</parameter>, <parameter>writeoffset</parameter>\r
            or <parameter>size</parameter> is negative, if <parameter>readoffset</parameter> + <parameter>size</parameter> exceeds the\r
            size of the buffer object bound to <parameter>readtarget</parameter> or if <parameter>writeoffset</parameter> + <parameter>size</parameter>\r
            exceeds the size of the buffer object bound to <parameter>writetarget</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if the same buffer object is bound to both <parameter>readtarget</parameter>\r
            and <parameter>writetarget</parameter> and the ranges [<parameter>readoffset</parameter>, <parameter>readoffset</parameter> +\r
            <parameter>size</parameter>) and [<parameter>writeoffset</parameter>, <parameter>writeoffset</parameter> + <parameter>size</parameter>)\r
            overlap.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>readtarget</parameter> or <parameter>writetarget</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if the buffer object bound to either <parameter>readtarget</parameter> or <parameter>writetarget</parameter>\r
            is mapped.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBufferSubData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetBufferSubData</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="glCopyBufferSubData">\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>glCopyBufferSubData</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glCopyBufferSubData</refname>\r
	17	<refpurpose>copy part of the data store of a buffer object to the data store of another buffer object</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glCopyBufferSubData</function></funcdef>\r
	23	<paramdef>GLenum <parameter>readtarget</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>writetarget</parameter></paramdef>\r
	25	<paramdef>GLintptr <parameter>readoffset</parameter></paramdef>\r
	26	<paramdef>GLintptr <parameter>writeoffset</parameter></paramdef>\r
	27	<paramdef>GLsizeiptr <parameter>size</parameter></paramdef>\r
	28	</funcprototype>\r
	29	</funcsynopsis>\r
	30	</refsynopsisdiv>\r
	31	<!-- eqn: ignoring delim $$ -->\r
	32	<refsect1 id="parameters"><title>Parameters</title>\r
	33	<variablelist>\r
	34	<varlistentry>\r
	35	<term><parameter>readtarget</parameter></term>\r
	36	<listitem>\r
	37	<para>\r
	38	Specifies the target from whose data store data should be read.\r
	39	</para>\r
	40	</listitem>\r
	41	</varlistentry>\r
	42	<varlistentry>\r
	43	<term><parameter>writetarget</parameter></term>\r
	44	<listitem>\r
	45	<para>\r
	46	Specifies the target to whose data store data should be written.\r
	47	</para>\r
	48	</listitem>\r
	49	</varlistentry>\r
	50	<varlistentry>\r
	51	<term><parameter>readoffset</parameter></term>\r
	52	<listitem>\r
	53	<para>\r
	54	Specifies the offset, in basic machine units, within the data store of <parameter>readtarget</parameter> from which data should be read.\r
	55	</para>\r
	56	</listitem>\r
	57	</varlistentry>\r
	58	<varlistentry>\r
	59	<term><parameter>writeoffset</parameter></term>\r
	60	<listitem>\r
	61	<para>\r
	62	Specifies the offset, in basic machine units, within the data store of <parameter>writetarget</parameter> to which data should be written.\r
	63	</para>\r
	64	</listitem>\r
65	</varlistentry>\r
66	<varlistentry>\r
67	<term><parameter>size</parameter></term>\r
68	<listitem>\r
69	<para>\r
70	Specifies the size, in basic machine units, of the data to be copied from <parameter>readtarget</parameter> to <parameter>writetarget</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>glCopyBufferSubData</function> copies part of the data store attached to <parameter>readtarget</parameter> to the\r
79	data store attached to <parameter>writetarget</parameter>. The number of basic machine units indicated by <parameter>size</parameter>\r
80	is copied from the source, at offset <parameter>readoffset</parameter> to the destination at <parameter>writeoffset</parameter>,\r
81	also in basic machine units.\r
82	</para>\r
83	<para>\r
84	<parameter>readtarget</parameter> and <parameter>writetarget</parameter> must be <constant>GL_ARRAY_BUFFER</constant>,\r
85	<constant>GL_COPY_READ_BUFFER</constant>, <constant>GL_COPY_WRITE_BUFFER</constant>, <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
86	<constant>GL_PIXEL_PACK_BUFFER</constant>, <constant>GL_PIXEL_UNPACK_BUFFER</constant>, <constant>GL_TEXTURE_BUFFER</constant>,\r
87	<constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>. Any of these targets may be used,\r
88	although the targets <constant>GL_COPY_READ_BUFFER</constant> and <constant>GL_COPY_WRITE_BUFFER</constant> are provided\r
89	specifically to allow copies between buffers without disturbing other GL state.\r
90	</para>\r
91	<para>\r
92	<parameter>readoffset</parameter>, <parameter>writeoffset</parameter> and <parameter>size</parameter> must all be greater than or equal to\r
93	zero. Furthermore, <parameter>readoffset</parameter> + <parameter>size</parameter> must not exceeed the size of the buffer\r
94	object bound to <parameter>readtarget</parameter>, and <parameter>readoffset</parameter> + <parameter>size</parameter> must not exceeed the\r
95	size of the buffer bound to <parameter>writetarget</parameter>. If the same buffer object is bound to both <parameter>readtarget</parameter>\r
96	and <parameter>writetarget</parameter>, then the ranges specified by <parameter>readoffset</parameter>, <parameter>writeoffset</parameter>\r
97	and <parameter>size</parameter> must not overlap.\r
98	</para>\r
99	</refsect1>\r
100	<refsect1 id="notes"><title>Notes</title>\r
101	<para>\r
102	<function>glCopyBufferSubData</function> is available only if the GL version is 3.1 or greater.\r
103	</para>\r
104	</refsect1>\r
105	<refsect1 id="errors"><title>Errors</title>\r
106	<para>\r
107	<constant>GL_INVALID_VALUE</constant> is generated if any of <parameter>readoffset</parameter>, <parameter>writeoffset</parameter>\r
108	or <parameter>size</parameter> is negative, if <parameter>readoffset</parameter> + <parameter>size</parameter> exceeds the\r
109	size of the buffer object bound to <parameter>readtarget</parameter> or if <parameter>writeoffset</parameter> + <parameter>size</parameter>\r
110	exceeds the size of the buffer object bound to <parameter>writetarget</parameter>.\r
111	</para>\r
112	<para>\r
113	<constant>GL_INVALID_VALUE</constant> is generated if the same buffer object is bound to both <parameter>readtarget</parameter>\r
114	and <parameter>writetarget</parameter> and the ranges [<parameter>readoffset</parameter>, <parameter>readoffset</parameter> +\r
115	<parameter>size</parameter>) and [<parameter>writeoffset</parameter>, <parameter>writeoffset</parameter> + <parameter>size</parameter>)\r
116	overlap.\r
117	</para>\r
118	<para>\r
119	<constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>readtarget</parameter> or <parameter>writetarget</parameter>.\r
120	</para>\r
121	<para>\r
122	<constant>GL_INVALID_OPERATION</constant> is generated if the buffer object bound to either <parameter>readtarget</parameter> or <parameter>writetarget</parameter>\r
123	is mapped.\r
124	</para>\r
125	</refsect1>\r
126	<refsect1 id="seealso"><title>See Also</title>\r
127	<para>\r
128	<citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>,\r
129	<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
130	<citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,\r
131	<citerefentry><refentrytitle>glBufferSubData</refentrytitle></citerefentry>,\r
132	<citerefentry><refentrytitle>glGetBufferSubData</refentrytitle></citerefentry>\r
133	</para>\r
134	</refsect1>\r
135	<refsect1 id="Copyright"><title>Copyright</title>\r
136	<para>\r
137	Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
138	This material may be distributed subject to the terms and conditions set forth in \r
139	the Open Publication License, v 1.0, 8 June 1999.\r
140	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
141	</para>\r
142	</refsect1>\r
143	</refentry>\r