61 lines
1.4 KiB
Plaintext
61 lines
1.4 KiB
Plaintext
|
vkCmdCopyImage(3)
|
||
|
|
==================
|
||
|
|
|
||
|
|
Name
|
||
|
|
----
|
||
|
|
vkCmdCopyImage - Copy data between images.
|
||
|
|
|
||
|
|
C Specification
|
||
|
|
---------------
|
||
|
|
|
||
|
|
include::../protos/vkCmdCopyImage.txt[]
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
|
||
|
|
pname:commandBuffer::
|
||
|
|
The command buffer into which the copy command is to be placed.
|
||
|
|
|
||
|
|
pname:srcImage::
|
||
|
|
The image that is the source for the data.
|
||
|
|
|
||
|
|
pname:srcImageLayout::
|
||
|
|
The layout of the source image at the time of the copy operation.
|
||
|
|
|
||
|
|
pname:dstImage::
|
||
|
|
The image that is to be the destination for the copy.
|
||
|
|
|
||
|
|
pname:dstImageLayout::
|
||
|
|
The layout of the destination image at the time of the copy operation.
|
||
|
|
|
||
|
|
pname:regionCount::
|
||
|
|
The number of regions to copy.
|
||
|
|
|
||
|
|
pname:pRegions::
|
||
|
|
An array of pname:regionCount regions to copy.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
fname:vkCmdCopyImage copies pname:regionCount regions of image data between pname:srcImage and
|
||
|
|
pname:dstImage. Each region is described by an element of the array pointed to by
|
||
|
|
pname:pRegions, which is an array of slink:VkImageCopy, the definition of which is:
|
||
|
|
|
||
|
|
include::../structs/VkImageCopy.txt[]
|
||
|
|
|
||
|
|
include::../validity/protos/vkCmdCopyImage.txt[]
|
||
|
|
|
||
|
|
Notes
|
||
|
|
-----
|
||
|
|
|
||
|
|
Although fname:vkCmdCopyBufferToImage 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:vkCmdCopyBuffer, flink:vkCmdCopyImageToBuffer, flink:vkCmdCopyBufferToImage
|
||
|
|
|
||
|
|
include::footer.txt[]
|