| CARVIEW |
vkTransitionImageLayout(3) Manual Page
Name
vkTransitionImageLayout - Perform an image layout transition on the host
Loading… please wait.
C Specification
To perform an image layout transition on the host, call:
// Provided by VK_VERSION_1_4
VkResult vkTransitionImageLayout(
VkDevice device,
uint32_t transitionCount,
const VkHostImageLayoutTransitionInfo* pTransitions);// Provided by VK_EXT_host_image_copy
// Equivalent to vkTransitionImageLayout
VkResult vkTransitionImageLayoutEXT(
VkDevice device,
uint32_t transitionCount,
const VkHostImageLayoutTransitionInfo* pTransitions);Parameters
-
deviceis the device which ownspTransitions[i].image. -
transitionCountis the number of image layout transitions to perform. -
pTransitionsis a pointer to an array of VkHostImageLayoutTransitionInfo structures specifying the image and subresource ranges within them to transition.
Description
-
VUID-vkTransitionImageLayout-device-parameter
devicemust be a valid VkDevice handle -
VUID-vkTransitionImageLayout-pTransitions-parameter
pTransitionsmust be a valid pointer to an array oftransitionCountvalid VkHostImageLayoutTransitionInfo structures -
VUID-vkTransitionImageLayout-transitionCount-arraylength
transitionCountmust be greater than0
- On success, this command returns
-
-
VK_SUCCESS
-
- On failure, this command returns
-
-
VK_ERROR_INITIALIZATION_FAILED -
VK_ERROR_MEMORY_MAP_FAILED -
VK_ERROR_OUT_OF_DEVICE_MEMORY -
VK_ERROR_OUT_OF_HOST_MEMORY -
VK_ERROR_UNKNOWN -
VK_ERROR_VALIDATION_FAILED
-
Document Notes
For more information, see the Vulkan Specification.
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.