2016-02-16 09:53:44 +00:00
|
|
|
vkCmdCopyBuffer(3)
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
Name
|
|
|
|
|
----
|
|
|
|
|
vkCmdCopyBuffer - Copy data between buffer regions.
|
|
|
|
|
|
|
|
|
|
C Specification
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
include::../protos/vkCmdCopyBuffer.txt[]
|
|
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
pname:commandBuffer::
|
|
|
|
|
The command buffer into which the copy command is to be placed.
|
|
|
|
|
|
|
|
|
|
pname:srcBuffer::
|
|
|
|
|
The buffer containing the data to be copied.
|
|
|
|
|
|
|
|
|
|
pname:dstBuffer::
|
|
|
|
|
The buffer into which data will be copied.
|
|
|
|
|
|
|
|
|
|
pname:regionCount::
|
|
|
|
|
The number of regions of data to copy.
|
|
|
|
|
|
|
|
|
|
pname:pRegions::
|
|
|
|
|
An array of pname:regionCount regions of data to be copied.
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
fname:vkCmdCopyBuffer copies regions of data from a source buffer to a destination
|
|
|
|
|
buffer. pname:regionCount regions are copied from pname:srcBuffer to pname:dstBuffer. Each
|
|
|
|
|
region is represented by a member of the pname:pRegions array, which is an array of
|
|
|
|
|
the slink:VkBufferCopy structure, whose definition is:
|
|
|
|
|
|
|
|
|
|
include::../structs/VkBufferCopy.txt[]
|
|
|
|
|
|
|
|
|
|
If any two or more regions within pname:pRegions overlap, the resulting data will be
|
Change log for April 29, 2016 Vulkan 1.0.12 spec update:
* Bump API patch number and header version number to 12 for this
update.
Github Issues:
* Change valid usage statements intended to be "sub-points" to
be actual sub-points (public issue 66).
* Replace double negation in description of
slink:VkRenderPassBeginInfo::pname:pClearValues (based on public
merge 142).
* Cleanup minor typos in spec, ref pages and XML, including those
proposed in public pull requests 144, 150, 151, 167, 168, 181, and
186.
* Use *strict subset* in describing the partial order of memory
property types for slink:VkMemoryType, and update the style guide
accordingly (public issue 190).
* Fix various "a image" -> "an image" typos (public issue 191).
* Note in the <<fundamentals-validusage,Valid Usage>> and
<<extensions-interactions,Extension Interactions>> sections that
structures defined by extensions which may be passed in structure
chains using the ptext:pNext member must: include initial
ptext:sType and ptext:pNext members (public issue 192).
Internal Issues:
* Remove duplicate language from the description of the pname:fence
parameter to flink:vkQueueSubmit and improve validity language
(internal issue 91).
* Added documentation for "optional" attribute to XML readme.tex/pdf
(internal issue 149).
* Clarify the host-side data validity rules and behavior of
flink:vkFlushMappedMemoryRanges and
flink:vkInvalidateMappedMemoryRanges (internal issue 266).
Other Commits:
* Added clarification to flink:vkCmdFillBuffer regarding the use of
ename:VK_WHOLE_SIZE.
* Fixed and documented implementation of "validextensionstructs"
attribute. in XML processing scripts and readme.tex/pdf.
* Add missing validity statements to flink:vkResetEvent and
flink:vkCmdResetEvent.
* Fix validity for the
ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag.
Correct all the draw/dispatch commands to mention optimally tiled
images as well as linear tiled images, and say image VIEWS instead
of images. Add validity statement to flink:vkCmdBlitImage
* Replace the {apiname} macro with hardcoded "Vulkan", now that we've
committed to that name.
* Add the VK_AMD_rasterization_order extension to vk.xml.
2016-04-29 12:53:46 +00:00
|
|
|
undefined. It is recommended, but not required, that the regions given in pname:pRegions
|
2016-02-16 09:53:44 +00:00
|
|
|
start on multiples of four bytes and have a length which is a multiple of four bytes.
|
|
|
|
|
|
|
|
|
|
include::../validity/protos/vkCmdCopyBuffer.txt[]
|
|
|
|
|
|
|
|
|
|
Notes
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Although fname:vkCmdCopyBuffer does not generate errors or return a value, enabled
|
|
|
|
|
validation layers may detect possible error conditions or potentially undefined
|
|
|
|
|
behavior and report this via some other means.
|
|
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
flink:vkCmdCopyImage, flink:vkCmdCopyBufferToImage, flink:vkCmdCopyImageToBuffer
|
|
|
|
|
|
|
|
|
|
include::footer.txt[]
|