VkHostImageLayoutTransitionInfo
The VkHostImageLayoutTransitionInfo structure is defined as:
typedef struct VkHostImageLayoutTransitionInfo {
VkStructureType sType;
const void* pNext;
VkImage image;
VkImageLayout oldLayout;
VkImageLayout newLayout;
VkImageSubresourceRange subresourceRange;
} VkHostImageLayoutTransitionInfo;
or the equivalent
typedef VkHostImageLayoutTransitionInfo VkHostImageLayoutTransitionInfoEXT;
sTypeis a VkStructureType value identifying this structure.pNextisNULLor a pointer to a structure extending this structure.imageis a handle to the image affected by this layout transition.oldLayoutis the old layout in an image layout transition.newLayoutis the new layout in an image layout transition.subresourceRangedescribes the image subresource range withinimagethat is affected by this layout transition.
vkTransitionImageLayout does not check whether the device memory
associated with an image is currently in use before performing the layout
transition.
The application must guarantee that any previously submitted command that
reads from or writes to this subresource has completed before the host
performs the layout transition.
The memory of image is accessed by the host as if coherent.
Image layout transitions performed on the host do not require queue family ownership transfers as the physical layout of the image will not vary between queue families for the layouts supported by this function.
If the device has written to the image memory, it is not automatically made
available to the host.
Before this command can be called, a memory barrier for this image must
have been issued on the device with the second
synchronization scope including
VK_PIPELINE_STAGE_HOST_BIT and VK_ACCESS_HOST_READ_BIT.
Because queue submissions automatically make host memory visible to the device, there would not be a need for a memory barrier before using the results of this layout transition on the device.
Valid Usage
VUID-VkHostImageLayoutTransitionInfo-image-09055
image must have been created with
VK_IMAGE_USAGE_HOST_TRANSFER_BIT
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-01486
subresourceRange.baseMipLevel must be less than the
mipLevels specified in VkImageCreateInfo when image
was created
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-01724
If subresourceRange.levelCount is not
VK_REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel
+ subresourceRange.levelCount must be less than or equal to
the mipLevels specified in VkImageCreateInfo when
image was created
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-01488
subresourceRange.baseArrayLayer must be less than the
arrayLayers specified in VkImageCreateInfo when image
was created
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-01725
If subresourceRange.layerCount is not
VK_REMAINING_ARRAY_LAYERS,
subresourceRange.baseArrayLayer +
subresourceRange.layerCount must be less than or equal to the
arrayLayers specified in VkImageCreateInfo when image
was created
VUID-VkHostImageLayoutTransitionInfo-image-01932
If image is non-sparse then it must be bound completely and
contiguously to a single VkDeviceMemory object
VUID-VkHostImageLayoutTransitionInfo-image-09241
If image has a color format
that is single-plane,
then the aspectMask member of subresourceRange must be
VK_IMAGE_ASPECT_COLOR_BIT
VUID-VkHostImageLayoutTransitionInfo-image-09242
If image has a color format and is not disjoint, then the
aspectMask member of subresourceRange must be
VK_IMAGE_ASPECT_COLOR_BIT
VUID-VkHostImageLayoutTransitionInfo-image-01672
If image has a multi-planar format and
the image is disjoint, then the aspectMask member of
subresourceRange must include at least one
multi-planar aspect mask bit or
VK_IMAGE_ASPECT_COLOR_BIT
VUID-VkHostImageLayoutTransitionInfo-image-03320
If image has a depth/stencil format with both depth and stencil
and the separateDepthStencilLayouts feature is not enabled,
then the aspectMask member of subresourceRange must include
both VK_IMAGE_ASPECT_DEPTH_BIT and
VK_IMAGE_ASPECT_STENCIL_BIT
VUID-VkHostImageLayoutTransitionInfo-image-03319
If image has a depth/stencil format with both depth and stencil
and the separateDepthStencilLayouts feature is enabled, then the
aspectMask member of subresourceRange must include either
or both VK_IMAGE_ASPECT_DEPTH_BIT and
VK_IMAGE_ASPECT_STENCIL_BIT
VUID-VkHostImageLayoutTransitionInfo-aspectMask-08702
If the aspectMask member of subresourceRange includes
VK_IMAGE_ASPECT_DEPTH_BIT, oldLayout and newLayoutmust not be one of VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or
VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
VUID-VkHostImageLayoutTransitionInfo-aspectMask-08703
If the aspectMask member of subresourceRange includes
VK_IMAGE_ASPECT_STENCIL_BIT, oldLayout and newLayoutmust not be one of VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or
VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-09601
subresourceRange.aspectMask must be valid for the format
the image was created with
VUID-VkHostImageLayoutTransitionInfo-oldLayout-09229
oldLayout must be either VK_IMAGE_LAYOUT_UNDEFINED or the
current layout of the image subresources as specified in
subresourceRange
VUID-VkHostImageLayoutTransitionInfo-oldLayout-09230
If oldLayout is not VK_IMAGE_LAYOUT_UNDEFINED or
VK_IMAGE_LAYOUT_PREINITIALIZED, it must be one of the layouts in
VkPhysicalDeviceHostImageCopyProperties::pCopySrcLayouts
VUID-VkHostImageLayoutTransitionInfo-newLayout-09057
newLayout must be one of the layouts in
VkPhysicalDeviceHostImageCopyProperties::pCopyDstLayouts
Valid Usage (Implicit)
VUID-VkHostImageLayoutTransitionInfo-sType-sType
sType must be VK_STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO
VUID-VkHostImageLayoutTransitionInfo-pNext-pNext
pNext must be NULL
VUID-VkHostImageLayoutTransitionInfo-image-parameter
image must be a valid VkImage handle
VUID-VkHostImageLayoutTransitionInfo-oldLayout-parameter
oldLayout must be a valid VkImageLayout value
VUID-VkHostImageLayoutTransitionInfo-newLayout-parameter
newLayout must be a valid VkImageLayout value
VUID-VkHostImageLayoutTransitionInfo-subresourceRange-parameter
subresourceRange must be a valid VkImageSubresourceRange structure