vkCmdCopyImageToBuffer(3)
==========================

Name
----
vkCmdCopyImageToBuffer - Copy image data into a buffer.

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

include::../protos/vkCmdCopyImageToBuffer.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:dstBuffer::
    The buffer that is to receive the copied data.

pname:regionCount::
    The number of regions to copy.

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

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

fname:vkCmdCopyImageToBuffer copies image data into a buffer object. pname:srcImage specifies
the image that is to be the source of the data. pname:dstBuffer is the buffer into which
the data is to be copied. pname:pRegions points to an array of pname:regionCount
slink:VkBufferImageCopy structures, the definition of which is:

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

include::../validity/protos/vkCmdCopyImageToBuffer.txt[]

Notes
-----

Although fname:vkCmdCopyImageToBuffer 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:vkCmdCopyBufferToImage, flink:vkCmdCopyImage

include::footer.txt[]