This extension allows applications to copy data between host memory and images on the host processor, without staging the data through a GPU-accessible buffer. This removes the need to allocate and manage the buffer and its associated memory. On some architectures it may also eliminate an extra copy operation. This extension additionally allows applications to copy data between images on the host.

To support initializing a new image in preparation for a host copy, it is now possible to transition a new image to IMAGE_LAYOUT_GENERAL or other host-copyable layouts via transitionImageLayoutEXT. Additionally, it is possible to perform copies that preserve the swizzling layout of the image by using the HOST_IMAGE_COPY_MEMCPY_EXT flag. In that case, the memory size needed for copies to or from a buffer can be retrieved by chaining SubresourceHostMemcpySizeEXT to pLayout in getImageSubresourceLayout2EXT.

New Commands

copyImageToImageEXT

New Structures

CopyImageToImageInfoEXT

CopyImageToMemoryInfoEXT
CopyMemoryToImageInfoEXT
HostImageLayoutTransitionInfoEXT
ImageSubresource2EXT
ImageToMemoryCopyEXT
MemoryToImageCopyEXT
SubresourceLayout2EXT
Extending ImageFormatProperties2:
- HostImageCopyDevicePerformanceQueryEXT
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceHostImageCopyFeaturesEXT
Extending PhysicalDeviceProperties2:
- PhysicalDeviceHostImageCopyPropertiesEXT
Extending SubresourceLayout2KHR:
- SubresourceHostMemcpySizeEXT

New Enums

HostImageCopyFlagBitsEXT

New Bitmasks

HostImageCopyFlagsEXT

New Enum Constants

EXT_HOST_IMAGE_COPY_EXTENSION_NAME

Issues

1) When uploading data to an image, the data is usually loaded from disk. Why not have the application load the data directly into a DeviceMemory bound to a buffer (instead of host memory), and use cmdCopyBufferToImage? The same could be done when downloading data from an image.

RESOLVED: This may not always be possible. Complicated Vulkan applications such as game engines often have decoupled subsystems for streaming data and rendering. It may be unreasonable to require the streaming subsystem to coordinate with the rendering subsystem to allocate memory on its behalf, especially as Vulkan may not be the only API supported by the engine. In emulation layers, the image data is necessarily provided by the application in host memory, so an optimization as suggested is not possible. Most importantly, the device memory may not be mappable by an application, but still accessible to the driver.

2) Are optimalBufferCopyOffsetAlignment and optimalBufferCopyRowPitchAlignment applicable to host memory as well with the functions introduced by this extension? Or should there be new limits?

RESOLVED: No alignment requirements for the host memory pointer.

3) Should there be granularity requirements for image offsets and extents?

RESOLVED: No granularity requirements, i.e. a granularity of 1 pixel (for non-compressed formats) and 1 texel block (for compressed formats) is assumed.

4) How should the application deal with layout transitions before or after copying to or from images?

RESOLVED: An existing issue with linear images is that when emulating other APIs, it is impossible to know when to transition them as they are written to by the host and then used bindlessly. The copy operations in this extension are affected by the same limitation. A new command is thus introduced by this extension to address this problem by allowing the host to perform an image layout transition between a handful of layouts.

Version History

Revision 0, 2021-01-20 (Faith Ekstrand)
- Initial idea and xml

Revision 1, 2023-04-26 (Shahbaz Youssefi)
- Initial revision

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

copyMemoryToImageEXT :: forall io. MonadIO io => Device -> CopyMemoryToImageInfoEXT -> io ()
copyImageToMemoryEXT :: forall io. MonadIO io => Device -> CopyImageToMemoryInfoEXT -> io ()
copyImageToImageEXT :: forall io. MonadIO io => Device -> CopyImageToImageInfoEXT -> io ()
transitionImageLayoutEXT :: forall io. MonadIO io => Device -> ("transitions" ::: Vector HostImageLayoutTransitionInfoEXT) -> io ()
getImageSubresourceLayout2EXT :: forall {a :: [Type]} {io}. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io) => Device -> Image -> ImageSubresource2KHR -> io (SubresourceLayout2KHR a)
data PhysicalDeviceHostImageCopyFeaturesEXT = PhysicalDeviceHostImageCopyFeaturesEXT {
- hostImageCopy :: Bool
}
data PhysicalDeviceHostImageCopyPropertiesEXT = PhysicalDeviceHostImageCopyPropertiesEXT {
- copySrcLayoutCount :: Word32
- copySrcLayouts :: Ptr ImageLayout
- copyDstLayoutCount :: Word32
- copyDstLayouts :: Ptr ImageLayout
- optimalTilingLayoutUUID :: ByteString
- identicalMemoryTypeRequirements :: Bool
}
data MemoryToImageCopyEXT = MemoryToImageCopyEXT {
- hostPointer :: Ptr ()
- memoryRowLength :: Word32
- memoryImageHeight :: Word32
- imageSubresource :: ImageSubresourceLayers
- imageOffset :: Offset3D
- imageExtent :: Extent3D
}
data ImageToMemoryCopyEXT = ImageToMemoryCopyEXT {
- hostPointer :: Ptr ()
- memoryRowLength :: Word32
- memoryImageHeight :: Word32
- imageSubresource :: ImageSubresourceLayers
- imageOffset :: Offset3D
- imageExtent :: Extent3D
}
data CopyMemoryToImageInfoEXT = CopyMemoryToImageInfoEXT {
- flags :: HostImageCopyFlagsEXT
- dstImage :: Image
- dstImageLayout :: ImageLayout
- regions :: Vector MemoryToImageCopyEXT
}
data CopyImageToMemoryInfoEXT = CopyImageToMemoryInfoEXT {
- flags :: HostImageCopyFlagsEXT
- srcImage :: Image
- srcImageLayout :: ImageLayout
- regions :: Vector ImageToMemoryCopyEXT
}
data CopyImageToImageInfoEXT = CopyImageToImageInfoEXT {
- flags :: HostImageCopyFlagsEXT
- srcImage :: Image
- srcImageLayout :: ImageLayout
- dstImage :: Image
- dstImageLayout :: ImageLayout
- regions :: Vector ImageCopy2
}
data HostImageLayoutTransitionInfoEXT = HostImageLayoutTransitionInfoEXT {
- image :: Image
- oldLayout :: ImageLayout
- newLayout :: ImageLayout
- subresourceRange :: ImageSubresourceRange
}
data SubresourceHostMemcpySizeEXT = SubresourceHostMemcpySizeEXT {
- size :: DeviceSize
}
data HostImageCopyDevicePerformanceQueryEXT = HostImageCopyDevicePerformanceQueryEXT {
- optimalDeviceAccess :: Bool
- identicalMemoryLayout :: Bool
}
type HostImageCopyFlagsEXT = HostImageCopyFlagBitsEXT
newtype HostImageCopyFlagBitsEXT where
- HostImageCopyFlagBitsEXT Flags
- pattern HOST_IMAGE_COPY_MEMCPY_EXT :: HostImageCopyFlagBitsEXT
type ImageSubresource2EXT = ImageSubresource2KHR
type SubresourceLayout2EXT = SubresourceLayout2KHR
type EXT_HOST_IMAGE_COPY_SPEC_VERSION = 1
pattern EXT_HOST_IMAGE_COPY_SPEC_VERSION :: forall a. Integral a => a
type EXT_HOST_IMAGE_COPY_EXTENSION_NAME = "VK_EXT_host_image_copy"
pattern EXT_HOST_IMAGE_COPY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
data ImageSubresource2KHR = ImageSubresource2KHR {
- imageSubresource :: ImageSubresource
}
data SubresourceLayout2KHR (es :: [Type]) = SubresourceLayout2KHR {
- next :: Chain es
- subresourceLayout :: SubresourceLayout
}
getImageSubresourceLayout2KHR :: forall a io. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io) => Device -> Image -> ImageSubresource2KHR -> io (SubresourceLayout2KHR a)

Documentation

copyMemoryToImageEXT Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the device which owns `pCopyMemoryToImageInfo->dstImage`. `device` must be a valid `Device` handle
-> CopyMemoryToImageInfoEXT	`pCopyMemoryToImageInfo` is a pointer to a `CopyMemoryToImageInfoEXT` structure describing the copy parameters. `pCopyMemoryToImageInfo` must be a valid pointer to a valid `CopyMemoryToImageInfoEXT` structure
-> io ()

vkCopyMemoryToImageEXT - Copy data from host memory into an image

Description

This command is functionally similar to cmdCopyBufferToImage2, except it is executed on the host and reads from host memory instead of a buffer. The memory of pCopyMemoryToImageInfo->dstImage is accessed by the host as if coherent.

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 copy operation on the device.

Return Codes

Success

SUCCESS

Failure

Description

This command is functionally similar to cmdCopyImageToBuffer2, except it is executed on the host and writes to host memory instead of a buffer. The memory of pCopyImageToMemoryInfo->srcImage is accessed by the host as if coherent.

If the device has written to the image memory, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and ACCESS_HOST_READ_BIT.

Return Codes

Success

SUCCESS

Failure

Description

This command is functionally similar to cmdCopyImage2, except it is executed on the host. The memory of pCopyImageToImageInfo->srcImage and pCopyImageToImageInfo->dstImage is accessed by the host as if coherent.

If the device has written to the memory of pCopyImageToImageInfo->srcImage, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and 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 copy operation in pCopyMemoryToImageInfo->dstImage on the device.

Return Codes

Success

SUCCESS

Failure

Members

This structure describes the following feature:

Description

If the PhysicalDeviceHostImageCopyFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceHostImageCopyFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Description

If the PhysicalDeviceHostImageCopyPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

If pCopyDstLayouts is NULL, then the number of image layouts that are supported in CopyMemoryToImageInfoEXT::dstImageLayout and CopyImageToImageInfoEXT::dstImageLayout is returned in copyDstLayoutCount. Otherwise, copyDstLayoutCount must be set by the application to the number of elements in the pCopyDstLayouts array, and on return the variable is overwritten with the number of values actually written to pCopyDstLayouts. If the value of copyDstLayoutCount is less than the number of image layouts that are supported, at most copyDstLayoutCount values will be written to pCopyDstLayouts. The implementation must include the IMAGE_LAYOUT_GENERAL image layout in pCopyDstLayouts.

If pCopySrcLayouts is NULL, then the number of image layouts that are supported in CopyImageToMemoryInfoEXT::srcImageLayout and CopyImageToImageInfoEXT::srcImageLayout is returned in copySrcLayoutCount. Otherwise, copySrcLayoutCount must be set by the application to the number of elements in the pCopySrcLayouts array, and on return the variable is overwritten with the number of values actually written to pCopySrcLayouts. If the value of copySrcLayoutCount is less than the number of image layouts that are supported, at most copySrcLayoutCount values will be written to pCopySrcLayouts. The implementation must include the IMAGE_LAYOUT_GENERAL image layout in pCopySrcLayouts.

The optimalTilingLayoutUUID value can be used to ensure compatible data layouts when using the HOST_IMAGE_COPY_MEMCPY_EXT flag in copyMemoryToImageEXT and copyImageToMemoryEXT.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT

If copySrcLayoutCount is not 0, and pCopySrcLayouts is not NULL, pCopySrcLayouts must be a valid pointer to an array of copySrcLayoutCount ImageLayout values
If copyDstLayoutCount is not 0, and pCopyDstLayouts is not NULL, pCopyDstLayouts must be a valid pointer to an array of copyDstLayoutCount ImageLayout values

Description

This structure is functionally similar to BufferImageCopy2, except it defines host memory as the source of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage

pHostPointer must point to memory that is large enough to contain all memory locations that are accessed according to Buffer and Image Addressing, for each element of pRegions

The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
memoryRowLength must be 0, or greater than or equal to the width member of imageExtent
memoryImageHeight must be 0, or greater than or equal to the height member of imageExtent
The aspectMask member of imageSubresource must only have a single bit set
imageExtent.width must not be 0
imageExtent.height must not be 0
imageExtent.depth must not be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT

pNext must be NULL
pHostPointer must be a pointer value
imageSubresource must be a valid ImageSubresourceLayers structure

Description

This structure is functionally similar to BufferImageCopy2, except it defines host memory as the target of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage

pHostPointer must point to memory that is large enough to contain all memory locations that are accessed according to Buffer and Image Addressing, for each element of pRegions

The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory
memoryRowLength must be 0, or greater than or equal to the width member of imageExtent
memoryImageHeight must be 0, or greater than or equal to the height member of imageExtent
The aspectMask member of imageSubresource must only have a single bit set
imageExtent.width must not be 0
imageExtent.height must not be 0
imageExtent.depth must not be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT

pNext must be NULL
pHostPointer must be a pointer value
imageSubresource must be a valid ImageSubresourceLayers structure

Description

copyMemoryToImageEXT does not check whether the device memory associated with dstImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that reads from or writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage

If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory

If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of dstImage are accessed, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the imageOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the imageExtent member of each element of pRegions must equal the extents of dstImage identified by imageSubresource
If dstImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
If imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when dstImage was created
dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
The image region specified by each element of pRegions must be contained within the specified imageSubresource of dstImage
For each element of pRegions, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of dstImage
For each element of pRegions, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of dstImage
dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT
If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, imageOffset.y must be 0 and imageExtent.height must be 1
For each element of pRegions, imageOffset.z and (imageExtent.depth + imageOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified imageSubresource of dstImage
If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, imageOffset.z must be 0 and imageExtent.depth must be 1
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, imageOffset.x must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and imageOffset.x does not equal the width of the subresource specified by imageSubresource, imageOffset.x must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, imageOffset.y must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and imageOffset.y does not equal the height of the subresource specified by imageSubresource, imageOffset.y must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, imageOffset.z must be a multiple of the texel block extent depth of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of imageOffset.x and extent.width does not equal the width of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of imageOffset.x and extent.height must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.x and extent.width must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of imageOffset.x and extent.height does not equal the width of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of imageOffset.y and extent.height does not equal the height of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of imageOffset.y and extent.width does not equal the height of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.y and extent.height must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of imageOffset.y and extent.width must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if the sum of imageOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of dstImage
For each element of pRegions, imageSubresource.aspectMask must specify aspects present in dstImage
If dstImage has a multi-planar image format, then for each element of pRegions, imageSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
For each element of pRegions, memoryRowLength must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, memoryImageHeight must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, memoryRowLength divided by the texel block extent width and then multiplied by the texel block size of dstImage must be less than or equal to 231-1
dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
dstImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts
If flags includes HOST_IMAGE_COPY_MEMCPY_EXT, for each region in pRegions, memoryRowLength and memoryImageHeight must both be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT

pNext must be NULL
flags must be a valid combination of HostImageCopyFlagBitsEXT values
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout value
pRegions must be a valid pointer to an array of regionCount valid MemoryToImageCopyEXT structures
regionCount must be greater than 0

Description

copyImageToMemoryEXT does not check whether the device memory associated with srcImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage

If srcImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory

If the stencil aspect of srcImage is accessed, and srcImage was not created with separate stencil usage, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of srcImage are accessed, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the imageOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the imageExtent member of each element of pRegions must equal the extents of srcImage identified by imageSubresource
If srcImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
If imageSubresource.layerCount is not REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when srcImage was created
srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
The image region specified by each element of pRegions must be contained within the specified imageSubresource of srcImage
For each element of pRegions, imageOffset.x and (imageExtent.width + imageOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified imageSubresource of srcImage
For each element of pRegions, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified imageSubresource of srcImage
srcImage must have a sample count equal to SAMPLE_COUNT_1_BIT
If srcImage is of type IMAGE_TYPE_1D, then for each element of pRegions, imageOffset.y must be 0 and imageExtent.height must be 1
For each element of pRegions, imageOffset.z and (imageExtent.depth + imageOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified imageSubresource of srcImage
If srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, imageOffset.z must be 0 and imageExtent.depth must be 1
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, imageOffset.x must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and imageOffset.x does not equal the width of the subresource specified by imageSubresource, imageOffset.x must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, imageOffset.y must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and imageOffset.y does not equal the height of the subresource specified by imageSubresource, imageOffset.y must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, imageOffset.z must be a multiple of the texel block extent depth of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of imageOffset.x and extent.width does not equal the width of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of imageOffset.x and extent.height must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.x and extent.width must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of imageOffset.x and extent.height does not equal the width of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of imageOffset.y and extent.height does not equal the height of the subresource specified by imageSubresource, extent.height must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of imageOffset.y and extent.width does not equal the height of the subresource specified by imageSubresource, extent.width must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of imageOffset.y and extent.height must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of imageOffset.y and extent.width must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if the sum of imageOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of srcImage
For each element of pRegions, imageSubresource.aspectMask must specify aspects present in srcImage
If srcImage has a multi-planar image format, then for each element of pRegions, imageSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If srcImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
For each element of pRegions, memoryRowLength must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, memoryImageHeight must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, memoryRowLength divided by the texel block extent width and then multiplied by the texel block size of srcImage must be less than or equal to 231-1
srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
srcImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts
If flags includes HOST_IMAGE_COPY_MEMCPY_EXT, for each region in pRegions, memoryRowLength and memoryImageHeight must both be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT

pNext must be NULL
flags must be a valid combination of HostImageCopyFlagBitsEXT values
srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout value
pRegions must be a valid pointer to an array of regionCount valid ImageToMemoryCopyEXT structures
regionCount must be greater than 0

Description

copyImageToImageEXT does not check whether the device memory associated with srcImage or dstImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that writes to the copy regions has completed before the host performs the copy.

Valid Usage

srcImage and dstImage must have been created with identical image creation parameters

If srcImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
If the stencil aspect of srcImage is accessed, and srcImage was not created with separate stencil usage, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of srcImage are accessed, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the srcOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the extent member of each element of pRegions must equal the extents of srcImage identified by srcSubresource
If srcImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
If srcSubresource.layerCount is not REMAINING_ARRAY_LAYERS, srcSubresource.baseArrayLayer + srcSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when srcImage was created
srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
The image region specified by each element of pRegions must be contained within the specified srcSubresource of srcImage
For each element of pRegions, srcOffset.x and (extent.width + srcOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified srcSubresource of srcImage
For each element of pRegions, srcOffset.y and (extent.height + srcOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified srcSubresource of srcImage
If srcImage is of type IMAGE_TYPE_1D, then for each element of pRegions, srcOffset.y must be 0 and extent.height must be 1
For each element of pRegions, srcOffset.z and (extent.depth + srcOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified srcSubresource of srcImage
If srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, srcOffset.z must be 0 and extent.depth must be 1
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, srcOffset.x must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and srcOffset.x does not equal the width of the subresource specified by srcSubresource, srcOffset.x must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, srcOffset.y must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and srcOffset.y does not equal the height of the subresource specified by srcSubresource, srcOffset.y must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, srcOffset.z must be a multiple of the texel block extent depth of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of srcOffset.x and extent.width does not equal the width of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of srcOffset.x and extent.height must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.x and extent.width must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of srcOffset.x and extent.height does not equal the width of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent width of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of srcOffset.y and extent.height does not equal the height of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of srcOffset.y and extent.width does not equal the height of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.y and extent.height must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of srcOffset.y and extent.width must be a multiple of the texel block extent height of the Format of srcImage
For each element of pRegions, if the sum of srcOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of srcImage
For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
If srcImage has a multi-planar image format, then for each element of pRegions, srcSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If srcImage is of type IMAGE_TYPE_3D, for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1
If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of dstImage are accessed, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in ImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the dstOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the extent member of each element of pRegions must equal the extents of dstImage identified by dstSubresource
If dstImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
If dstSubresource.layerCount is not REMAINING_ARRAY_LAYERS, dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in ImageCreateInfo when dstImage was created
dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
The image region specified by each element of pRegions must be contained within the specified dstSubresource of dstImage
For each element of pRegions, dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified dstSubresource of dstImage
For each element of pRegions, dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified dstSubresource of dstImage
If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, dstOffset.y must be 0 and extent.height must be 1
For each element of pRegions, dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage
If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0 and extent.depth must be 1
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, dstOffset.x must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and dstOffset.x does not equal the width of the subresource specified by dstSubresource, dstOffset.x must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, dstOffset.y must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and dstOffset.y does not equal the height of the subresource specified by dstSubresource, dstOffset.y must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, dstOffset.z must be a multiple of the texel block extent depth of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of dstOffset.x and extent.width does not equal the width of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of dstOffset.x and extent.height must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.x and extent.width must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of dstOffset.x and extent.height does not equal the width of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent width of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of dstOffset.y and extent.height does not equal the height of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of dstOffset.y and extent.width does not equal the height of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.y and extent.height must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if CopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of dstOffset.y and extent.width must be a multiple of the texel block extent height of the Format of dstImage
For each element of pRegions, if the sum of dstOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the Format of dstImage
For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
If dstImage has a multi-planar image format, then for each element of pRegions, dstSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
srcImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts
dstImageLayout must be one of the image layouts returned in PhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT

pNext must be NULL
flags must be a valid combination of HostImageCopyFlagBitsEXT values
srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout value
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout value
pRegions must be a valid pointer to an array of regionCount valid ImageCopy2 structures
regionCount must be greater than 0
Both of dstImage, and srcImage must have been created, allocated, or retrieved from the same Device

Description

transitionImageLayoutEXT 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 PIPELINE_STAGE_HOST_BIT and 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

image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT

subresourceRange.baseMipLevel must be less than the mipLevels specified in ImageCreateInfo when image was created
If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in ImageCreateInfo when image was created
subresourceRange.baseArrayLayer must be less than the arrayLayers specified in ImageCreateInfo when image was created
If subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the arrayLayers specified in ImageCreateInfo when image was created
If image is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
If image has a color format that is single-plane, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
If image has a color format and is not disjoint, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
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 IMAGE_ASPECT_COLOR_BIT
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 IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
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 IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
If the aspectMask member of subresourceRange includes IMAGE_ASPECT_DEPTH_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If the aspectMask member of subresourceRange includes IMAGE_ASPECT_STENCIL_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
subresourceRange.aspectMask must be valid for the format the image was created with
oldLayout must be either IMAGE_LAYOUT_UNDEFINED or the current layout of the image subresources as specified in subresourceRange
If oldLayout is not IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED, it must be one of the layouts in PhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts
newLayout must be one of the layouts in PhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT

pNext must be NULL
image must be a valid Image handle
oldLayout must be a valid ImageLayout value
newLayout must be a valid ImageLayout value
subresourceRange must be a valid ImageSubresourceRange structure

Description

The implementation may return FALSE in optimalDeviceAccess if identicalMemoryLayout is FALSE. If identicalMemoryLayout is TRUE, optimalDeviceAccess must be TRUE.

The implementation may return TRUE in optimalDeviceAccess while identicalMemoryLayout is FALSE. In this situation, any device performance impact should not be measurable.

If PhysicalDeviceImageFormatInfo2::format is a block-compressed format and getPhysicalDeviceImageFormatProperties2 returns SUCCESS, the implementation must return TRUE in optimalDeviceAccess.

Applications can make use of optimalDeviceAccess to determine their resource copying strategy. If a resource is expected to be accessed more on device than on the host, and the implementation considers the resource sub-optimally accessed, it is likely better to use device copies instead.

Layout not being identical yet still considered optimal for device access could happen if the implementation has different memory layout patterns, some of which are easier to access on the host.

The most practical reason for optimalDeviceAccess to be FALSE is that host image access may disable framebuffer compression where it would otherwise have been enabled. This represents far more efficient host image access since no compression algorithm is required to read or write to the image, but it would impact device access performance. Some implementations may only set optimalDeviceAccess to FALSE if certain conditions are met, such as specific image usage flags or creation flags.

Valid Usage (Implicit)

Description

getImageSubresourceLayout2KHR behaves similarly to getImageSubresourceLayout, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

It is legal to call getImageSubresourceLayout2KHR with an image created with tiling equal to IMAGE_TILING_OPTIMAL, but the members of SubresourceLayout2KHR::subresourceLayout will have undefined values in this case.

Structures chained from ImageSubresource2KHR::pNext will also be updated when tiling is equal to IMAGE_TILING_OPTIMAL.

Valid Usage

The aspectMask member of pSubresource must only have a single bit set

The mipLevel member of pSubresource must be less than the mipLevels specified in image
The arrayLayer member of pSubresource must be less than the arrayLayers specified in image
If format of the image is a color format that is not a multi-planar image format, and tiling of the image is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, the aspectMask member of pSubresource must be IMAGE_ASPECT_COLOR_BIT
If format of the image has a depth component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_DEPTH_BIT
If format of the image has a stencil component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_STENCIL_BIT
If format of the image does not contain a stencil or depth component, the aspectMask member of pSubresource must not contain IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
If the tiling of the image is IMAGE_TILING_LINEAR and has a multi-planar image format, then the aspectMask member of pSubresource must be a single valid multi-planar aspect mask bit
If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID external memory handle type, then image must be bound to memory
If the tiling of the image is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then the aspectMask member of pSubresource must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT and the index i must be less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier

Valid Usage (Implicit)

device must be a valid Device handle

image must be a valid Image handle
pSubresource must be a valid pointer to a valid ImageSubresource2KHR structure
pLayout must be a valid pointer to a SubresourceLayout2KHR structure
image must have been created, allocated, or retrieved from device

Storable PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: PhysicalDeviceHostImageCopyFeaturesEXT -> Int # alignment :: PhysicalDeviceHostImageCopyFeaturesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> Int -> IO PhysicalDeviceHostImageCopyFeaturesEXT # pokeElemOff :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> Int -> PhysicalDeviceHostImageCopyFeaturesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceHostImageCopyFeaturesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceHostImageCopyFeaturesEXT -> IO () # peek :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> IO PhysicalDeviceHostImageCopyFeaturesEXT # poke :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> PhysicalDeviceHostImageCopyFeaturesEXT -> IO () #
Show PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> PhysicalDeviceHostImageCopyFeaturesEXT -> ShowS # show :: PhysicalDeviceHostImageCopyFeaturesEXT -> String # showList :: [PhysicalDeviceHostImageCopyFeaturesEXT] -> ShowS #
Eq PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods (==) :: PhysicalDeviceHostImageCopyFeaturesEXT -> PhysicalDeviceHostImageCopyFeaturesEXT -> Bool # (/=) :: PhysicalDeviceHostImageCopyFeaturesEXT -> PhysicalDeviceHostImageCopyFeaturesEXT -> Bool #
FromCStruct PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> IO PhysicalDeviceHostImageCopyFeaturesEXT Source #
ToCStruct PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: PhysicalDeviceHostImageCopyFeaturesEXT -> (Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> PhysicalDeviceHostImageCopyFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceHostImageCopyFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceHostImageCopyFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: PhysicalDeviceHostImageCopyFeaturesEXT Source #

Storable PhysicalDeviceHostImageCopyPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: PhysicalDeviceHostImageCopyPropertiesEXT -> Int # alignment :: PhysicalDeviceHostImageCopyPropertiesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> Int -> IO PhysicalDeviceHostImageCopyPropertiesEXT # pokeElemOff :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> Int -> PhysicalDeviceHostImageCopyPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceHostImageCopyPropertiesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceHostImageCopyPropertiesEXT -> IO () # peek :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> IO PhysicalDeviceHostImageCopyPropertiesEXT # poke :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> PhysicalDeviceHostImageCopyPropertiesEXT -> IO () #
Show PhysicalDeviceHostImageCopyPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> PhysicalDeviceHostImageCopyPropertiesEXT -> ShowS # show :: PhysicalDeviceHostImageCopyPropertiesEXT -> String # showList :: [PhysicalDeviceHostImageCopyPropertiesEXT] -> ShowS #
FromCStruct PhysicalDeviceHostImageCopyPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> IO PhysicalDeviceHostImageCopyPropertiesEXT Source #
ToCStruct PhysicalDeviceHostImageCopyPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: PhysicalDeviceHostImageCopyPropertiesEXT -> (Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> PhysicalDeviceHostImageCopyPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceHostImageCopyPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceHostImageCopyPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: PhysicalDeviceHostImageCopyPropertiesEXT Source #

Storable MemoryToImageCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: MemoryToImageCopyEXT -> Int # alignment :: MemoryToImageCopyEXT -> Int # peekElemOff :: Ptr MemoryToImageCopyEXT -> Int -> IO MemoryToImageCopyEXT # pokeElemOff :: Ptr MemoryToImageCopyEXT -> Int -> MemoryToImageCopyEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryToImageCopyEXT # pokeByteOff :: Ptr b -> Int -> MemoryToImageCopyEXT -> IO () # peek :: Ptr MemoryToImageCopyEXT -> IO MemoryToImageCopyEXT # poke :: Ptr MemoryToImageCopyEXT -> MemoryToImageCopyEXT -> IO () #
Show MemoryToImageCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> MemoryToImageCopyEXT -> ShowS # show :: MemoryToImageCopyEXT -> String # showList :: [MemoryToImageCopyEXT] -> ShowS #
FromCStruct MemoryToImageCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr MemoryToImageCopyEXT -> IO MemoryToImageCopyEXT Source #
ToCStruct MemoryToImageCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: MemoryToImageCopyEXT -> (Ptr MemoryToImageCopyEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryToImageCopyEXT -> MemoryToImageCopyEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryToImageCopyEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryToImageCopyEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryToImageCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: MemoryToImageCopyEXT Source #

Storable ImageToMemoryCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: ImageToMemoryCopyEXT -> Int # alignment :: ImageToMemoryCopyEXT -> Int # peekElemOff :: Ptr ImageToMemoryCopyEXT -> Int -> IO ImageToMemoryCopyEXT # pokeElemOff :: Ptr ImageToMemoryCopyEXT -> Int -> ImageToMemoryCopyEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageToMemoryCopyEXT # pokeByteOff :: Ptr b -> Int -> ImageToMemoryCopyEXT -> IO () # peek :: Ptr ImageToMemoryCopyEXT -> IO ImageToMemoryCopyEXT # poke :: Ptr ImageToMemoryCopyEXT -> ImageToMemoryCopyEXT -> IO () #
Show ImageToMemoryCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> ImageToMemoryCopyEXT -> ShowS # show :: ImageToMemoryCopyEXT -> String # showList :: [ImageToMemoryCopyEXT] -> ShowS #
FromCStruct ImageToMemoryCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr ImageToMemoryCopyEXT -> IO ImageToMemoryCopyEXT Source #
ToCStruct ImageToMemoryCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: ImageToMemoryCopyEXT -> (Ptr ImageToMemoryCopyEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageToMemoryCopyEXT -> ImageToMemoryCopyEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageToMemoryCopyEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageToMemoryCopyEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImageToMemoryCopyEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: ImageToMemoryCopyEXT Source #

Show CopyMemoryToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> CopyMemoryToImageInfoEXT -> ShowS # show :: CopyMemoryToImageInfoEXT -> String # showList :: [CopyMemoryToImageInfoEXT] -> ShowS #
FromCStruct CopyMemoryToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr CopyMemoryToImageInfoEXT -> IO CopyMemoryToImageInfoEXT Source #
ToCStruct CopyMemoryToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: CopyMemoryToImageInfoEXT -> (Ptr CopyMemoryToImageInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr CopyMemoryToImageInfoEXT -> CopyMemoryToImageInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr CopyMemoryToImageInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr CopyMemoryToImageInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero CopyMemoryToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: CopyMemoryToImageInfoEXT Source #

:: forall io. MonadIO io
=> Device	`device` is the device which owns `pTransitions`[i].`image`. `device` must be a valid `Device` handle
-> ("transitions" ::: Vector HostImageLayoutTransitionInfoEXT)	`pTransitions` is a pointer to an array of `HostImageLayoutTransitionInfoEXT` structures specifying the image and subresource ranges within them to transition. `pTransitions` must be a valid pointer to an array of `transitionCount` valid `HostImageLayoutTransitionInfoEXT` structures
-> io ()

PhysicalDeviceHostImageCopyFeaturesEXT
Fields hostImageCopy :: Bool `hostImageCopy` indicates that the implementation supports copying from host memory to images using the `copyMemoryToImageEXT` command, copying from images to host memory using the `copyImageToMemoryEXT` command, and copying between images using the `copyImageToImageEXT` command.

Show CopyImageToMemoryInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> CopyImageToMemoryInfoEXT -> ShowS # show :: CopyImageToMemoryInfoEXT -> String # showList :: [CopyImageToMemoryInfoEXT] -> ShowS #
FromCStruct CopyImageToMemoryInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr CopyImageToMemoryInfoEXT -> IO CopyImageToMemoryInfoEXT Source #
ToCStruct CopyImageToMemoryInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: CopyImageToMemoryInfoEXT -> (Ptr CopyImageToMemoryInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr CopyImageToMemoryInfoEXT -> CopyImageToMemoryInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr CopyImageToMemoryInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr CopyImageToMemoryInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero CopyImageToMemoryInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: CopyImageToMemoryInfoEXT Source #

Show CopyImageToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> CopyImageToImageInfoEXT -> ShowS # show :: CopyImageToImageInfoEXT -> String # showList :: [CopyImageToImageInfoEXT] -> ShowS #
FromCStruct CopyImageToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr CopyImageToImageInfoEXT -> IO CopyImageToImageInfoEXT Source #
ToCStruct CopyImageToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: CopyImageToImageInfoEXT -> (Ptr CopyImageToImageInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr CopyImageToImageInfoEXT -> CopyImageToImageInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr CopyImageToImageInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr CopyImageToImageInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero CopyImageToImageInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: CopyImageToImageInfoEXT Source #

Storable HostImageLayoutTransitionInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: HostImageLayoutTransitionInfoEXT -> Int # alignment :: HostImageLayoutTransitionInfoEXT -> Int # peekElemOff :: Ptr HostImageLayoutTransitionInfoEXT -> Int -> IO HostImageLayoutTransitionInfoEXT # pokeElemOff :: Ptr HostImageLayoutTransitionInfoEXT -> Int -> HostImageLayoutTransitionInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO HostImageLayoutTransitionInfoEXT # pokeByteOff :: Ptr b -> Int -> HostImageLayoutTransitionInfoEXT -> IO () # peek :: Ptr HostImageLayoutTransitionInfoEXT -> IO HostImageLayoutTransitionInfoEXT # poke :: Ptr HostImageLayoutTransitionInfoEXT -> HostImageLayoutTransitionInfoEXT -> IO () #
Show HostImageLayoutTransitionInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> HostImageLayoutTransitionInfoEXT -> ShowS # show :: HostImageLayoutTransitionInfoEXT -> String # showList :: [HostImageLayoutTransitionInfoEXT] -> ShowS #
FromCStruct HostImageLayoutTransitionInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr HostImageLayoutTransitionInfoEXT -> IO HostImageLayoutTransitionInfoEXT Source #
ToCStruct HostImageLayoutTransitionInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: HostImageLayoutTransitionInfoEXT -> (Ptr HostImageLayoutTransitionInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr HostImageLayoutTransitionInfoEXT -> HostImageLayoutTransitionInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr HostImageLayoutTransitionInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr HostImageLayoutTransitionInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero HostImageLayoutTransitionInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: HostImageLayoutTransitionInfoEXT Source #

SubresourceHostMemcpySizeEXT
Fields size :: DeviceSize `size` is the size in bytes of the image subresource.

Storable SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: SubresourceHostMemcpySizeEXT -> Int # alignment :: SubresourceHostMemcpySizeEXT -> Int # peekElemOff :: Ptr SubresourceHostMemcpySizeEXT -> Int -> IO SubresourceHostMemcpySizeEXT # pokeElemOff :: Ptr SubresourceHostMemcpySizeEXT -> Int -> SubresourceHostMemcpySizeEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO SubresourceHostMemcpySizeEXT # pokeByteOff :: Ptr b -> Int -> SubresourceHostMemcpySizeEXT -> IO () # peek :: Ptr SubresourceHostMemcpySizeEXT -> IO SubresourceHostMemcpySizeEXT # poke :: Ptr SubresourceHostMemcpySizeEXT -> SubresourceHostMemcpySizeEXT -> IO () #
Show SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> SubresourceHostMemcpySizeEXT -> ShowS # show :: SubresourceHostMemcpySizeEXT -> String # showList :: [SubresourceHostMemcpySizeEXT] -> ShowS #
Eq SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods (==) :: SubresourceHostMemcpySizeEXT -> SubresourceHostMemcpySizeEXT -> Bool # (/=) :: SubresourceHostMemcpySizeEXT -> SubresourceHostMemcpySizeEXT -> Bool #
FromCStruct SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr SubresourceHostMemcpySizeEXT -> IO SubresourceHostMemcpySizeEXT Source #
ToCStruct SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: SubresourceHostMemcpySizeEXT -> (Ptr SubresourceHostMemcpySizeEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr SubresourceHostMemcpySizeEXT -> SubresourceHostMemcpySizeEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr SubresourceHostMemcpySizeEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr SubresourceHostMemcpySizeEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero SubresourceHostMemcpySizeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: SubresourceHostMemcpySizeEXT Source #

Storable HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: HostImageCopyDevicePerformanceQueryEXT -> Int # alignment :: HostImageCopyDevicePerformanceQueryEXT -> Int # peekElemOff :: Ptr HostImageCopyDevicePerformanceQueryEXT -> Int -> IO HostImageCopyDevicePerformanceQueryEXT # pokeElemOff :: Ptr HostImageCopyDevicePerformanceQueryEXT -> Int -> HostImageCopyDevicePerformanceQueryEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO HostImageCopyDevicePerformanceQueryEXT # pokeByteOff :: Ptr b -> Int -> HostImageCopyDevicePerformanceQueryEXT -> IO () # peek :: Ptr HostImageCopyDevicePerformanceQueryEXT -> IO HostImageCopyDevicePerformanceQueryEXT # poke :: Ptr HostImageCopyDevicePerformanceQueryEXT -> HostImageCopyDevicePerformanceQueryEXT -> IO () #
Show HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> HostImageCopyDevicePerformanceQueryEXT -> ShowS # show :: HostImageCopyDevicePerformanceQueryEXT -> String # showList :: [HostImageCopyDevicePerformanceQueryEXT] -> ShowS #
Eq HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods (==) :: HostImageCopyDevicePerformanceQueryEXT -> HostImageCopyDevicePerformanceQueryEXT -> Bool # (/=) :: HostImageCopyDevicePerformanceQueryEXT -> HostImageCopyDevicePerformanceQueryEXT -> Bool #
FromCStruct HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods peekCStruct :: Ptr HostImageCopyDevicePerformanceQueryEXT -> IO HostImageCopyDevicePerformanceQueryEXT Source #
ToCStruct HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods withCStruct :: HostImageCopyDevicePerformanceQueryEXT -> (Ptr HostImageCopyDevicePerformanceQueryEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr HostImageCopyDevicePerformanceQueryEXT -> HostImageCopyDevicePerformanceQueryEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr HostImageCopyDevicePerformanceQueryEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr HostImageCopyDevicePerformanceQueryEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero HostImageCopyDevicePerformanceQueryEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: HostImageCopyDevicePerformanceQueryEXT Source #

Storable HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods sizeOf :: HostImageCopyFlagBitsEXT -> Int # alignment :: HostImageCopyFlagBitsEXT -> Int # peekElemOff :: Ptr HostImageCopyFlagBitsEXT -> Int -> IO HostImageCopyFlagBitsEXT # pokeElemOff :: Ptr HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO HostImageCopyFlagBitsEXT # pokeByteOff :: Ptr b -> Int -> HostImageCopyFlagBitsEXT -> IO () # peek :: Ptr HostImageCopyFlagBitsEXT -> IO HostImageCopyFlagBitsEXT # poke :: Ptr HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> IO () #
Bits HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods (.&.) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT # (.\|.) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT # xor :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT # complement :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT # shift :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # rotate :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # zeroBits :: HostImageCopyFlagBitsEXT # bit :: Int -> HostImageCopyFlagBitsEXT # setBit :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # clearBit :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # complementBit :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # testBit :: HostImageCopyFlagBitsEXT -> Int -> Bool # bitSizeMaybe :: HostImageCopyFlagBitsEXT -> Maybe Int # bitSize :: HostImageCopyFlagBitsEXT -> Int # isSigned :: HostImageCopyFlagBitsEXT -> Bool # shiftL :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # unsafeShiftL :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # shiftR :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # unsafeShiftR :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # rotateL :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # rotateR :: HostImageCopyFlagBitsEXT -> Int -> HostImageCopyFlagBitsEXT # popCount :: HostImageCopyFlagBitsEXT -> Int #
FiniteBits HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods finiteBitSize :: HostImageCopyFlagBitsEXT -> Int # countLeadingZeros :: HostImageCopyFlagBitsEXT -> Int # countTrailingZeros :: HostImageCopyFlagBitsEXT -> Int #
Read HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods readsPrec :: Int -> ReadS HostImageCopyFlagBitsEXT # readList :: ReadS [HostImageCopyFlagBitsEXT] # readPrec :: ReadPrec HostImageCopyFlagBitsEXT # readListPrec :: ReadPrec [HostImageCopyFlagBitsEXT] #
Show HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods showsPrec :: Int -> HostImageCopyFlagBitsEXT -> ShowS # show :: HostImageCopyFlagBitsEXT -> String # showList :: [HostImageCopyFlagBitsEXT] -> ShowS #
Eq HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods (==) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool # (/=) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool #
Ord HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods compare :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Ordering # (<) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool # (<=) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool # (>) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool # (>=) :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> Bool # max :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT # min :: HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT -> HostImageCopyFlagBitsEXT #
Zero HostImageCopyFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_host_image_copy Methods zero :: HostImageCopyFlagBitsEXT Source #

ImageSubresource2KHR
Fields imageSubresource :: ImageSubresource `imageSubresource` is a `ImageSubresource` structure. `imageSubresource` must be a valid `ImageSubresource` structure

SubresourceLayout2KHR
Fields next :: Chain es `pNext` is `NULL` or a pointer to a structure extending this structure. subresourceLayout :: SubresourceLayout `subresourceLayout` is a `SubresourceLayout` structure.

Storable ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods sizeOf :: ImageSubresource2KHR -> Int # alignment :: ImageSubresource2KHR -> Int # peekElemOff :: Ptr ImageSubresource2KHR -> Int -> IO ImageSubresource2KHR # pokeElemOff :: Ptr ImageSubresource2KHR -> Int -> ImageSubresource2KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageSubresource2KHR # pokeByteOff :: Ptr b -> Int -> ImageSubresource2KHR -> IO () # peek :: Ptr ImageSubresource2KHR -> IO ImageSubresource2KHR # poke :: Ptr ImageSubresource2KHR -> ImageSubresource2KHR -> IO () #
Show ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods showsPrec :: Int -> ImageSubresource2KHR -> ShowS # show :: ImageSubresource2KHR -> String # showList :: [ImageSubresource2KHR] -> ShowS #
FromCStruct ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods peekCStruct :: Ptr ImageSubresource2KHR -> IO ImageSubresource2KHR Source #
ToCStruct ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods withCStruct :: ImageSubresource2KHR -> (Ptr ImageSubresource2KHR -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageSubresource2KHR -> ImageSubresource2KHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageSubresource2KHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageSubresource2KHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImageSubresource2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods zero :: ImageSubresource2KHR Source #

Extensible SubresourceLayout2KHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). SubresourceLayout2KHR es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [Type]). SubresourceLayout2KHR ds -> Chain es -> SubresourceLayout2KHR es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends SubresourceLayout2KHR e => b) -> Maybe b Source #
Show (Chain es) => Show (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods showsPrec :: Int -> SubresourceLayout2KHR es -> ShowS # show :: SubresourceLayout2KHR es -> String # showList :: [SubresourceLayout2KHR es] -> ShowS #
(Extendss SubresourceLayout2KHR es, PeekChain es) => FromCStruct (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods peekCStruct :: Ptr (SubresourceLayout2KHR es) -> IO (SubresourceLayout2KHR es) Source #
(Extendss SubresourceLayout2KHR es, PokeChain es) => ToCStruct (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods withCStruct :: SubresourceLayout2KHR es -> (Ptr (SubresourceLayout2KHR es) -> IO b) -> IO b Source # pokeCStruct :: Ptr (SubresourceLayout2KHR es) -> SubresourceLayout2KHR es -> IO b -> IO b Source # withZeroCStruct :: (Ptr (SubresourceLayout2KHR es) -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr (SubresourceLayout2KHR es) -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
es ~ ('[] :: [Type]) => Zero (SubresourceLayout2KHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_maintenance5 Methods zero :: SubresourceLayout2KHR es Source #

:: forall a io. (Extendss SubresourceLayout2KHR a, PokeChain a, PeekChain a, MonadIO io)
=> Device	`device` is the logical device that owns the image.
-> Image	`image` is the image whose layout is being queried.
-> ImageSubresource2KHR	`pSubresource` is a pointer to a `ImageSubresource2KHR` structure selecting a specific image for the image subresource.
-> io (SubresourceLayout2KHR a)

Name

VK_EXT_host_image_copy

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Bitmasks

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Description

Return Codes

See Also

Description

Return Codes

See Also

Description

Return Codes

See Also

Return Codes

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description