vkCmdCopyBufferToImage(3)
==========================

Name
----
vkCmdCopyBufferToImage - Copy data from a buffer into an image.

C Specification
---------------

include::../protos/vkCmdCopyBufferToImage.txt[]

Parameters
----------

pname:commandBuffer::
    The command buffer into which the copy command is to be placed.

pname:srcBuffer::
    The buffer from which data is to be sourced.

pname:dstImage::
    The image that is to be the destination for the copy.

pname:dstImageLayout::
    The image layout of the destination image at the time of the copy operation.

pname:regionCount::
    The number of image regions to update.

pname:pRegions::
    An array of pname:regionCount regions to update.

Description
-----------

fname:vkCmdCopyBufferToImage copies pname:regionCount regions of data from pname:srcBuffer
into pname:dstImage. pname:pRegions points to an array of slink:VkBufferImageCopy structures
which describe the regions to be copied. The definition of slink:VkBufferImageCopy is:

include::../structs/VkBufferImageCopy.txt[]

include::../validity/protos/vkCmdCopyBufferToImage.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

include::footer.txt[]