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

63 lines
1.6 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/
vkCmdCopyImageToBuffer(3)
=========================
Name
----
vkCmdCopyImageToBuffer - Copy image data into a buffer.
C Specification
---------------
// refBegin vkCmdCopyImageToBuffer Copy image data into a buffer.
To copy data from an image object to a buffer object, call:
include::../protos/vkCmdCopyImageToBuffer.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command will be
recorded.
* pname:srcImage is the source image.
* pname:srcImageLayout is the layout of the source image subresources for
the copy.
* 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:VkBufferImageCopy
structures specifying the regions to copy.
Description
-----------
Each region in pname:pRegions is copied from the specified region of the
source image to the specified region of the destination buffer.
include::../validity/protos/vkCmdCopyImageToBuffer.txt[]
See Also
--------
slink:VkBuffer, slink:VkBufferImageCopy, slink:VkCommandBuffer, slink:VkImage, elink:VkImageLayout
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdCopyImageToBuffer
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]