Difference between revisions of "GLAPI/glCopyBufferSubData"

From OpenGL Wiki
Jump to navigation Jump to search
m (Bot: Adjusting API page category.)
m (Bot: Adding better formatting.)
 
(8 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glCopyBufferSubData'''(GLenum ''readtarget'', GLenum ''writetarget'', GLintptr ''readoffset'', GLintptr ''writeoffset'', GLsizeiptr ''size'');
+
   void '''glCopyBufferSubData'''(GLenum {{param|readtarget}}, GLenum {{param|writetarget}}, GLintptr {{param|readoffset}}, GLintptr {{param|writeoffset}}, GLsizeiptr {{param|size}});
  
; readtarget
+
{{glapi buffertargets|name=readtarget|desc=Specifies the target from whose data store data should be read.}}
: Specifies the target from whose data store data should be read.
+
{{glapi buffertargets|name=writetarget|desc=Specifies the target to whose data store data should be written.}}
; writetarget
 
: Specifies the target to whose data store data should be written.
 
 
; readoffset
 
; readoffset
: Specifies the offset, in basic machine units, within the data store of ''readtarget'' from which data should be read.
+
: Specifies the offset, in basic machine units, within the data store of {{param|readtarget}} from which data should be read.
 
; writeoffset
 
; writeoffset
: Specifies the offset, in basic machine units, within the data store of ''writetarget'' to which data should be written.
+
: Specifies the offset, in basic machine units, within the data store of {{param|writetarget}} to which data should be written.
 
; size
 
; size
: Specifies the size, in basic machine units, of the data to be copied from ''readtarget'' to ''writetarget''.
+
: Specifies the size, in basic machine units, of the data to be copied from {{param|readtarget}} to {{param|writetarget}}.
  
 
== Description ==
 
== Description ==
  
'''glCopyBufferSubData''' copies part of the data store attached to ''readtarget'' to the data store attached to ''writetarget''. The number of basic machine units indicated by ''size'' is copied from the source, at offset ''readoffset'' to the destination at ''writeoffset'', also in basic machine units.
+
'''glCopyBufferSubData''' copies part of the data store attached to {{param|readtarget}} to the data store attached to {{param|writetarget}}. The number of basic machine units indicated by {{param|size}} is copied from the source, at offset {{param|readoffset}} to the destination at {{param|writeoffset}}, also in basic machine units.
  
''readtarget'' and ''writetarget'' must be {{code|GL_ARRAY_BUFFER}}, {{code|GL_COPY_READ_BUFFER}}, {{code|GL_COPY_WRITE_BUFFER}}, {{code|GL_ELEMENT_ARRAY_BUFFER}}, {{code|GL_PIXEL_PACK_BUFFER}}, {{code|GL_PIXEL_UNPACK_BUFFER}}, {{code|GL_TEXTURE_BUFFER}}, {{code|GL_TRANSFORM_FEEDBACK_BUFFER}} or {{code|GL_UNIFORM_BUFFER}}. Any of these targets may be used, although the targets {{code|GL_COPY_READ_BUFFER}} and {{code|GL_COPY_WRITE_BUFFER}} are provided specifically to allow copies between buffers without disturbing other GL state.
+
{{param|readtarget}} and {{param|writetarget}} must be valid buffer object binding targets. Any of these targets may be used, although the targets {{enum|GL_COPY_READ_BUFFER}} and {{enum|GL_COPY_WRITE_BUFFER}} are provided specifically to allow copies between buffers without disturbing other GL state.
  
''readoffset'', ''writeoffset'' and ''size'' must all be greater than or equal to zero. Furthermore, ''readoffset'' + ''size'' must not exceeed the size of the buffer object bound to ''readtarget'', and ''readoffset'' + ''size'' must not exceeed the size of the buffer bound to ''writetarget''. If the same buffer object is bound to both ''readtarget'' and ''writetarget'', then the ranges specified by ''readoffset'', ''writeoffset'' and ''size'' must not overlap.
+
{{param|readoffset}}, {{param|writeoffset}} and {{param|size}} must all be greater than or equal to zero. Furthermore, {{param|readoffset}} + {{param|size}} must not exceeed the size of the buffer object bound to {{param|readtarget}}, and {{param|readoffset}} + {{param|size}} must not exceeed the size of the buffer bound to {{param|writetarget}}. If the same buffer object is bound to both {{param|readtarget}} and {{param|writetarget}}, then the ranges specified by {{param|readoffset}}, {{param|writeoffset}} and {{param|size}} must not overlap.
  
 
== Notes ==
 
== Notes ==
  
'''glCopyBufferSubData''' is available only if the GL version is 3.1 or greater.
+
The {{enum|GL_DISPATCH_INDIRECT_BUFFER}} and {{enum|GL_SHADER_STORAGE_BUFFER}} targets are available only if the GL version is 4.3 or greater.
 +
 
 +
The {{enum|GL_QUERY_BUFFER}} target is available only if the GL version is 4.4 or greater.
  
 
== Errors ==
 
== Errors ==
  
{{code|GL_INVALID_VALUE}} is generated if any of ''readoffset'', ''writeoffset'' or ''size'' is negative, if ''readoffset'' + ''size'' exceeds the size of the buffer object bound to ''readtarget'' or if ''writeoffset'' + ''size'' exceeds the size of the buffer object bound to ''writetarget''.
+
{{enum|GL_INVALID_VALUE}} is generated if any of {{param|readoffset}}, {{param|writeoffset}} or {{param|size}} is negative, if {{param|readoffset}} + {{param|size}} exceeds the size of the buffer object bound to {{param|readtarget}} or if {{param|writeoffset}} + {{param|size}} exceeds the size of the buffer object bound to {{param|writetarget}}.
  
{{code|GL_INVALID_VALUE}} is generated if the same buffer object is bound to both ''readtarget'' and ''writetarget'' and the ranges [''readoffset'', ''readoffset'' + ''size'') and [''writeoffset'', ''writeoffset'' + ''size'') overlap.
+
{{enum|GL_INVALID_VALUE}} is generated if the same buffer object is bound to both {{param|readtarget}} and {{param|writetarget}} and the ranges [{{param|readoffset}}, {{param|readoffset}} + {{param|size}}) and [{{param|writeoffset}}, {{param|writeoffset}} + {{param|size}}) overlap.
  
{{code|GL_INVALID_OPERATION}} is generated if zero is bound to ''readtarget'' or ''writetarget''.
+
{{enum|GL_INVALID_OPERATION}} is generated if zero is bound to {{param|readtarget}} or {{param|writetarget}}.
  
{{code|GL_INVALID_OPERATION}} is generated if the buffer object bound to either ''readtarget'' or ''writetarget'' is mapped.
+
{{enum|GL_INVALID_OPERATION}} is generated if the buffer object bound to either {{param|readtarget}} or {{param|writetarget}} is mapped.
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glGenBuffers|glGenBuffers]], [[GLAPI/glBindBuffer|glBindBuffer]], [[GLAPI/glBufferData|glBufferData]], [[GLAPI/glBufferSubData|glBufferSubData]], [[GLAPI/glGetBufferSubData|glGetBufferSubData]]
+
{{apifunc|glBindBuffer}}, {{apifunc|glBufferData}}, {{apifunc|glBufferSubData}}, {{apifunc|glClearBufferSubData}}, {{apifunc|glInvalidateBufferSubData}}, {{apifunc|glMapBufferRange}}, {{apifunc|glUnmapBuffer}}
  
 
== Copyright ==
 
== Copyright ==
  
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
+
Copyright © 2010-2013 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
  
[[Category:API Reference 4|CopyBufferSubData]]
+
[[Category:Core API Ref Buffer Objects|CopyBufferSubData]]
[[Category:GL 4 API Buffer Objects|CopyBufferSubData]]
+
[[Category:Core API Reference|CopyBufferSubData]]
 +
[[Category:Buffer Object API State Functions|CopyBufferSubData]]

Latest revision as of 09:51, 15 August 2013

glCopyBufferSubData
Core in version 4.6
Core since version 3.1

glCopyBufferSubData: copy part of the data store of a buffer object to the data store of another buffer object

Function Definition

 void glCopyBufferSubData(GLenum readtarget​, GLenum writetarget​, GLintptr readoffset​, GLintptr writeoffset​, GLsizeiptr size​);
readtarget
Specifies the target from whose data store data should be read. The symbolic constant must be GL_ARRAY_BUFFER, GL_ATOMIC_COUNTER_BUFFER, GL_COPY_READ_BUFFER, GL_COPY_WRITE_BUFFER, GL_DRAW_INDIRECT_BUFFER, GL_DISPATCH_INDIRECT_BUFFER, GL_ELEMENT_ARRAY_BUFFER, GL_PIXEL_PACK_BUFFER, GL_PIXEL_UNPACK_BUFFER, GL_QUERY_BUFFER, GL_SHADER_STORAGE_BUFFER, GL_TEXTURE_BUFFER, GL_TRANSFORM_FEEDBACK_BUFFER, or GL_UNIFORM_BUFFER.
writetarget
Specifies the target to whose data store data should be written. The symbolic constant must be GL_ARRAY_BUFFER, GL_ATOMIC_COUNTER_BUFFER, GL_COPY_READ_BUFFER, GL_COPY_WRITE_BUFFER, GL_DRAW_INDIRECT_BUFFER, GL_DISPATCH_INDIRECT_BUFFER, GL_ELEMENT_ARRAY_BUFFER, GL_PIXEL_PACK_BUFFER, GL_PIXEL_UNPACK_BUFFER, GL_QUERY_BUFFER, GL_SHADER_STORAGE_BUFFER, GL_TEXTURE_BUFFER, GL_TRANSFORM_FEEDBACK_BUFFER, or GL_UNIFORM_BUFFER.
readoffset
Specifies the offset, in basic machine units, within the data store of readtarget​ from which data should be read.
writeoffset
Specifies the offset, in basic machine units, within the data store of writetarget​ to which data should be written.
size
Specifies the size, in basic machine units, of the data to be copied from readtarget​ to writetarget​.

Description

glCopyBufferSubData copies part of the data store attached to readtarget​ to the data store attached to writetarget​. The number of basic machine units indicated by size​ is copied from the source, at offset readoffset​ to the destination at writeoffset​, also in basic machine units.

readtarget​ and writetarget​ must be valid buffer object binding targets. Any of these targets may be used, although the targets GL_COPY_READ_BUFFER and GL_COPY_WRITE_BUFFER are provided specifically to allow copies between buffers without disturbing other GL state.

readoffset​, writeoffset​ and size​ must all be greater than or equal to zero. Furthermore, readoffset​ + size​ must not exceeed the size of the buffer object bound to readtarget​, and readoffset​ + size​ must not exceeed the size of the buffer bound to writetarget​. If the same buffer object is bound to both readtarget​ and writetarget​, then the ranges specified by readoffset​, writeoffset​ and size​ must not overlap.

Notes

The GL_DISPATCH_INDIRECT_BUFFER and GL_SHADER_STORAGE_BUFFER targets are available only if the GL version is 4.3 or greater.

The GL_QUERY_BUFFER target is available only if the GL version is 4.4 or greater.

Errors

GL_INVALID_VALUE is generated if any of readoffset​, writeoffset​ or size​ is negative, if readoffset​ + size​ exceeds the size of the buffer object bound to readtarget​ or if writeoffset​ + size​ exceeds the size of the buffer object bound to writetarget​.

GL_INVALID_VALUE is generated if the same buffer object is bound to both readtarget​ and writetarget​ and the ranges [readoffset​, readoffset​ + size​) and [writeoffset​, writeoffset​ + size​) overlap.

GL_INVALID_OPERATION is generated if zero is bound to readtarget​ or writetarget​.

GL_INVALID_OPERATION is generated if the buffer object bound to either readtarget​ or writetarget​ is mapped.

See Also

glBindBuffer, glBufferData, glBufferSubData, glClearBufferSubData, glInvalidateBufferSubData, glMapBufferRange, glUnmapBuffer

Copyright

Copyright © 2010-2013 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.