65 lines
3.1 KiB
Plaintext
65 lines
3.1 KiB
Plaintext
|
// WARNING: DO NOT MODIFY! This file is automatically generated from the vk.xml registry
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
.Valid Usage
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
Valid Usage
|
||
|
|
-----------
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
* pname:commandBuffer must: be a valid sname:VkCommandBuffer handle
|
||
|
|
* pname:srcImage must: be a valid sname:VkImage handle
|
||
|
|
* pname:srcImageLayout must: be a valid elink:VkImageLayout value
|
||
|
|
* pname:dstBuffer must: be a valid sname:VkBuffer handle
|
||
|
|
* pname:pRegions must: be a pointer to an array of pname:regionCount valid sname:VkBufferImageCopy structures
|
||
|
|
* pname:commandBuffer must: be in the recording state
|
||
|
|
* The sname:VkCommandPool that pname:commandBuffer was allocated from must: support transfer, graphics or compute operations
|
||
|
|
* This command must: only be called outside of a render pass instance
|
||
|
|
* The value of pname:regionCount must: be greater than `0`
|
||
|
|
* Each of pname:commandBuffer, pname:srcImage and pname:dstBuffer must: have been created, allocated or retrieved from the same sname:VkDevice
|
||
|
|
* The image region specified by a given element of pname:pRegions must: be a region that is contained within pname:srcImage
|
||
|
|
* The buffer region specified by a given element of pname:pRegions must: be a region that is contained within pname:dstBuffer
|
||
|
|
* The union of all source regions, and the union of all destination regions, specified by the elements of pname:pRegions, mustnot: overlap in memory
|
||
|
|
* pname:srcImage must: have been created with pname:VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
|
||
|
|
* pname:srcImage must: have a sample count equal to ename:VK_SAMPLE_COUNT_1_BIT
|
||
|
|
* pname:srcImageLayout must: specify the layout of the subresources of pname:srcImage specified in pname:pRegions at the time this command is executed on a sname:VkDevice
|
||
|
|
* pname:srcImageLayout must: be either of VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or VK_IMAGE_LAYOUT_GENERAL
|
||
|
|
* pname:dstBuffer must: have been created with pname:VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
.Host Synchronization
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
Host Synchronization
|
||
|
|
--------------------
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
* Host access to pname:commandBuffer must: be externally synchronized
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
.Command Properties
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
Command Properties
|
||
|
|
------------------
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
[options="header", width="100%"]
|
||
|
|
|=====================
|
||
|
|
|Command Buffer Levels|Render Pass Scope|Supported Queue Types
|
||
|
|
|Primary +
|
||
|
|
Secondary|Outside|TRANSFER +
|
||
|
|
GRAPHICS +
|
||
|
|
COMPUTE
|
||
|
|
|=====================
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
|