Vulkan-Docs/doc/specs/vulkan/man/vkCmdCopyBuffer.txt

63 lines
1.5 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkCmdCopyBuffer(3)
==================
Name
----
vkCmdCopyBuffer - Copy data between buffer regions.
C Specification
---------------
// refBegin vkCmdCopyBuffer Copy data between buffer regions.
To copy data between buffer objects, call:
include::../api/protos/vkCmdCopyBuffer.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command will be
recorded.
* pname:srcBuffer is the source buffer.
* pname:dstBuffer is the destination buffer.
* pname:regionCount is the number of regions to copy.
* pname:pRegions is a pointer to an array of slink:VkBufferCopy structures
specifying the regions to copy.
Description
-----------
Each region in pname:pRegions is copied from the source buffer to the same
region of the destination buffer. pname:srcBuffer and pname:dstBuffer can:
be the same buffer or alias the same memory, but the result is undefined if
the copy regions overlap in memory.
include::../validity/protos/vkCmdCopyBuffer.txt[]
See Also
--------
slink:VkBuffer, slink:VkBufferCopy, slink:VkCommandBuffer
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdCopyBuffer
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]