Vulkan.Extensions.VK_KHR_copy_commands2

Name

VK_KHR_copy_commands2 - device extension

VK_KHR_copy_commands2

Name String

VK_KHR_copy_commands2

Extension Type

Device extension

Registered Extension Number

338

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0

Contact

• Jeff Leger @jackohound%0A<<Here describe the issue or question you have about the VK_KHR_copy_commands2 extension> >

Other Extension Metadata

Last Modified Date

2020-07-06

Interactions and External Dependencies

• None

Contributors

• Jeff Leger, Qualcomm
• Tobias Hector, AMD
• Jan-Harald Fredriksen, ARM
• Tom Olson, ARM

Description

This extension provides extensible versions of the Vulkan buffer and image copy commands. The new commands are functionally identical to the core commands, except that their copy parameters are specified using extensible structures that can be used to pass extension-specific information.

The following extensible copy commands are introduced with this extension: cmdCopyBuffer2KHR, cmdCopyImage2KHR, cmdCopyBufferToImage2KHR, cmdCopyImageToBuffer2KHR, cmdBlitImage2KHR, and cmdResolveImage2KHR. Each command contains an *Info2KHR structure parameter that includes sType/pNext members. Lower level structures describing each region to be copied are also extended with sType/pNext members.

New Commands

• cmdBlitImage2KHR

• cmdCopyBuffer2KHR
• cmdCopyBufferToImage2KHR
• cmdCopyImage2KHR
• cmdCopyImageToBuffer2KHR
• cmdResolveImage2KHR

New Structures

• BlitImageInfo2KHR

• BufferCopy2KHR
• BufferImageCopy2KHR
• CopyBufferInfo2KHR
• CopyBufferToImageInfo2KHR
• CopyImageInfo2KHR
• CopyImageToBufferInfo2KHR
• ImageBlit2KHR
• ImageCopy2KHR
• ImageResolve2KHR
• ResolveImageInfo2KHR

New Enum Constants

• KHR_COPY_COMMANDS_2_EXTENSION_NAME

• KHR_COPY_COMMANDS_2_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_BLIT_IMAGE_INFO_2_KHR
  • STRUCTURE_TYPE_BUFFER_COPY_2_KHR
  • STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2_KHR
  • STRUCTURE_TYPE_COPY_BUFFER_INFO_2_KHR
  • STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2_KHR
  • STRUCTURE_TYPE_COPY_IMAGE_INFO_2_KHR
  • STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2_KHR
  • STRUCTURE_TYPE_IMAGE_BLIT_2_KHR
  • STRUCTURE_TYPE_IMAGE_COPY_2_KHR
  • STRUCTURE_TYPE_IMAGE_RESOLVE_2_KHR
  • STRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2_KHR

Version History

• Revision 1, 2020-07-06 (Jeff Leger)

  • Internal revisions

See Also

BlitImageInfo2KHR, BufferCopy2KHR, BufferImageCopy2KHR, CopyBufferInfo2KHR, CopyBufferToImageInfo2KHR, CopyImageInfo2KHR, CopyImageToBufferInfo2KHR, ImageBlit2KHR, ImageCopy2KHR, ImageResolve2KHR, ResolveImageInfo2KHR, cmdBlitImage2KHR, cmdCopyBuffer2KHR, cmdCopyBufferToImage2KHR, cmdCopyImage2KHR, cmdCopyImageToBuffer2KHR, cmdResolveImage2KHR

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.

Documentation

cmdCopyBuffer2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> CopyBufferInfo2KHR

pCopyBufferInfo is a pointer to a CopyBufferInfo2KHR structure describing the copy parameters.

-> io ()

vkCmdCopyBuffer2KHR - Copy data between buffer regions

Description

This command is functionally identical to cmdCopyBuffer, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcBuffer must not be a protected buffer

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstBuffer must not be a protected buffer
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstBuffer must not be an unprotected buffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyBufferInfo must be a valid pointer to a valid CopyBufferInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Transfer Graphics Compute

See Also

VK_KHR_copy_commands2, CommandBuffer, CopyBufferInfo2KHR

cmdCopyImage2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> CopyImageInfo2KHR

pCopyImageInfo is a pointer to a CopyImageInfo2KHR structure describing the copy parameters.

-> io ()

vkCmdCopyImage2KHR - Copy data between images

Description

This command is functionally identical to cmdCopyImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyImageInfo must be a valid pointer to a valid CopyImageInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Transfer Graphics Compute

See Also

VK_KHR_copy_commands2, CommandBuffer, CopyImageInfo2KHR

cmdBlitImage2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> BlitImageInfo2KHR

pBlitImageInfo is a pointer to a BlitImageInfo2KHR structure describing the blit parameters.

-> io ()

vkCmdBlitImage2KHR - Copy regions of an image, potentially performing format conversion,

Description

This command is functionally identical to cmdBlitImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pBlitImageInfo must be a valid pointer to a valid BlitImageInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Graphics

See Also

VK_KHR_copy_commands2, BlitImageInfo2KHR, CommandBuffer

cmdCopyBufferToImage2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> CopyBufferToImageInfo2KHR

pCopyBufferToImageInfo is a pointer to a CopyBufferToImageInfo2KHR structure describing the copy parameters.

-> io ()

vkCmdCopyBufferToImage2KHR - Copy data from a buffer into an image

Description

This command is functionally identical to cmdCopyBufferToImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcBuffer must not be a protected buffer

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyBufferToImageInfo must be a valid pointer to a valid CopyBufferToImageInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Transfer Graphics Compute

See Also

VK_KHR_copy_commands2, CommandBuffer, CopyBufferToImageInfo2KHR

cmdCopyImageToBuffer2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> CopyImageToBufferInfo2KHR

pCopyImageToBufferInfo is a pointer to a CopyImageToBufferInfo2KHR structure describing the copy parameters.

-> io ()

vkCmdCopyImageToBuffer2KHR - Copy image data into a buffer

Description

This command is functionally identical to cmdCopyImageToBuffer, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstBuffer must not be a protected buffer
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstBuffer must not be an unprotected buffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pCopyImageToBufferInfo must be a valid pointer to a valid CopyImageToBufferInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Transfer Graphics Compute

See Also

VK_KHR_copy_commands2, CommandBuffer, CopyImageToBufferInfo2KHR

cmdResolveImage2KHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> ResolveImageInfo2KHR

pResolveImageInfo is a pointer to a ResolveImageInfo2KHR structure describing the resolve parameters.

-> io ()

vkCmdResolveImage2KHR - Resolve regions of an image

Description

This command is functionally identical to cmdResolveImage, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, srcImage must not be a protected image

• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, dstImage must not be a protected image
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, dstImage must not be an unprotected image

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pResolveImageInfo must be a valid pointer to a valid ResolveImageInfo2KHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Outside	Graphics

See Also

VK_KHR_copy_commands2, CommandBuffer, ResolveImageInfo2KHR

data BufferCopy2KHR

VkBufferCopy2KHR - Structure specifying a buffer copy operation

Valid Usage

• The size must be greater than 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_COPY_2_KHR

• pNext must be NULL

See Also

VK_KHR_copy_commands2, CopyBufferInfo2KHR, DeviceSize, StructureType

Constructors

BufferCopy2KHR

Fields

• srcOffset :: DeviceSize

  srcOffset is the starting offset in bytes from the start of srcBuffer.

• dstOffset :: DeviceSize

  dstOffset is the starting offset in bytes from the start of dstBuffer.

• size :: DeviceSize

  size is the number of bytes to copy.

Instances

Eq BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

(==) :: BufferCopy2KHR -> BufferCopy2KHR -> Bool

(/=) :: BufferCopy2KHR -> BufferCopy2KHR -> Bool

Show BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> BufferCopy2KHR -> ShowS

show :: BufferCopy2KHR -> String

showList :: [BufferCopy2KHR] -> ShowS

Storable BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

sizeOf :: BufferCopy2KHR -> Int

alignment :: BufferCopy2KHR -> Int

peekElemOff :: Ptr BufferCopy2KHR -> Int -> IO BufferCopy2KHR

pokeElemOff :: Ptr BufferCopy2KHR -> Int -> BufferCopy2KHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO BufferCopy2KHR

pokeByteOff :: Ptr b -> Int -> BufferCopy2KHR -> IO ()

peek :: Ptr BufferCopy2KHR -> IO BufferCopy2KHR

poke :: Ptr BufferCopy2KHR -> BufferCopy2KHR -> IO ()

FromCStruct BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr BufferCopy2KHR -> IO BufferCopy2KHR

ToCStruct BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: BufferCopy2KHR -> (Ptr BufferCopy2KHR -> IO b) -> IO b

pokeCStruct :: Ptr BufferCopy2KHR -> BufferCopy2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr BufferCopy2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr BufferCopy2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BufferCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: BufferCopy2KHR

data ImageCopy2KHR

VkImageCopy2KHR - Structure specifying an image copy operation

Valid Usage

• The number of slices of the extent (for 3D) or layers of the srcSubresource (for non-3D) must match the number of slices of the extent (for 3D) or layers of the dstSubresource (for non-3D)

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_COPY_2_KHR

• pNext must be NULL
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, CopyImageInfo2KHR, Extent3D, ImageSubresourceLayers, Offset3D, StructureType

Constructors

ImageCopy2KHR

Fields

• srcSubresource :: ImageSubresourceLayers

  srcSubresource and dstSubresource are ImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.

• srcOffset :: Offset3D

  srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.

• dstSubresource :: ImageSubresourceLayers
• dstOffset :: Offset3D
• extent :: Extent3D

  extent is the size in texels of the image to copy in width, height and depth.

Instances

Show ImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> ImageCopy2KHR -> ShowS

show :: ImageCopy2KHR -> String

showList :: [ImageCopy2KHR] -> ShowS

Storable ImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

sizeOf :: ImageCopy2KHR -> Int

alignment :: ImageCopy2KHR -> Int

peekElemOff :: Ptr ImageCopy2KHR -> Int -> IO ImageCopy2KHR

pokeElemOff :: Ptr ImageCopy2KHR -> Int -> ImageCopy2KHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImageCopy2KHR

pokeByteOff :: Ptr b -> Int -> ImageCopy2KHR -> IO ()

peek :: Ptr ImageCopy2KHR -> IO ImageCopy2KHR

poke :: Ptr ImageCopy2KHR -> ImageCopy2KHR -> IO ()

FromCStruct ImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr ImageCopy2KHR -> IO ImageCopy2KHR

ToCStruct ImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: ImageCopy2KHR -> (Ptr ImageCopy2KHR -> IO b) -> IO b

pokeCStruct :: Ptr ImageCopy2KHR -> ImageCopy2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr ImageCopy2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageCopy2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: ImageCopy2KHR

data ImageBlit2KHR (es :: [Type])

VkImageBlit2KHR - Structure specifying an image blit operation

Description

For each element of the pRegions array, a blit operation is performed for the specified source and destination regions.

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must match

• The layerCount member of srcSubresource and dstSubresource must match

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_BLIT_2_KHR

• pNext must be NULL or a pointer to a valid instance of CopyCommandTransformInfoQCOM
• The sType value of each struct in the pNext chain must be unique
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, BlitImageInfo2KHR, ImageSubresourceLayers, Offset3D, StructureType

Constructors

ImageBlit2KHR

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• srcSubresource :: ImageSubresourceLayers

  srcSubresource is the subresource to blit from.

• srcOffsets :: (Offset3D, Offset3D)

  srcOffsets is a pointer to an array of two Offset3D structures specifying the bounds of the source region within srcSubresource.

• dstSubresource :: ImageSubresourceLayers

  dstSubresource is the subresource to blit into.

• dstOffsets :: (Offset3D, Offset3D)

  dstOffsets is a pointer to an array of two Offset3D structures specifying the bounds of the destination region within dstSubresource.

Instances

Extensible ImageBlit2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). ImageBlit2KHR es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). ImageBlit2KHR ds -> Chain es -> ImageBlit2KHR es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends ImageBlit2KHR e => b) -> Maybe b

Show (Chain es) => Show (ImageBlit2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> ImageBlit2KHR es -> ShowS

show :: ImageBlit2KHR es -> String

showList :: [ImageBlit2KHR es] -> ShowS

(Extendss ImageBlit2KHR es, PeekChain es) => FromCStruct (ImageBlit2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr (ImageBlit2KHR es) -> IO (ImageBlit2KHR es)

(Extendss ImageBlit2KHR es, PokeChain es) => ToCStruct (ImageBlit2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: ImageBlit2KHR es -> (Ptr (ImageBlit2KHR es) -> IO b) -> IO b

pokeCStruct :: Ptr (ImageBlit2KHR es) -> ImageBlit2KHR es -> IO b -> IO b

withZeroCStruct :: (Ptr (ImageBlit2KHR es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (ImageBlit2KHR es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (ImageBlit2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: ImageBlit2KHR es

data BufferImageCopy2KHR (es :: [Type])

VkBufferImageCopy2KHR - Structure specifying a buffer image copy operation

Description

This structure is functionally identical to BufferImageCopy, but adds sType and pNext parameters, allowing it to be more easily extended.

Valid Usage

• bufferRowLength must be 0, or greater than or equal to the width member of imageExtent

• bufferImageHeight 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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2_KHR

• pNext must be NULL or a pointer to a valid instance of CopyCommandTransformInfoQCOM
• The sType value of each struct in the pNext chain must be unique
• imageSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, CopyBufferToImageInfo2KHR, CopyImageToBufferInfo2KHR, DeviceSize, Extent3D, ImageSubresourceLayers, Offset3D, StructureType

Constructors

BufferImageCopy2KHR

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• bufferOffset :: DeviceSize

  bufferOffset is the offset in bytes from the start of the buffer object where the image data is copied from or to.

• bufferRowLength :: Word32

  bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations. If either of these values is zero, that aspect of the buffer memory is considered to be tightly packed according to the imageExtent.

• bufferImageHeight :: Word32
• imageSubresource :: ImageSubresourceLayers

  imageSubresource is a ImageSubresourceLayers used to specify the specific image subresources of the image used for the source or destination image data.

• imageOffset :: Offset3D

  imageOffset selects the initial x, y, z offsets in texels of the sub-region of the source or destination image data.

• imageExtent :: Extent3D

  imageExtent is the size in texels of the image to copy in width, height and depth.

Instances

Extensible BufferImageCopy2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). BufferImageCopy2KHR es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). BufferImageCopy2KHR ds -> Chain es -> BufferImageCopy2KHR es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends BufferImageCopy2KHR e => b) -> Maybe b

Show (Chain es) => Show (BufferImageCopy2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> BufferImageCopy2KHR es -> ShowS

show :: BufferImageCopy2KHR es -> String

showList :: [BufferImageCopy2KHR es] -> ShowS

(Extendss BufferImageCopy2KHR es, PeekChain es) => FromCStruct (BufferImageCopy2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr (BufferImageCopy2KHR es) -> IO (BufferImageCopy2KHR es)

(Extendss BufferImageCopy2KHR es, PokeChain es) => ToCStruct (BufferImageCopy2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: BufferImageCopy2KHR es -> (Ptr (BufferImageCopy2KHR es) -> IO b) -> IO b

pokeCStruct :: Ptr (BufferImageCopy2KHR es) -> BufferImageCopy2KHR es -> IO b -> IO b

withZeroCStruct :: (Ptr (BufferImageCopy2KHR es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (BufferImageCopy2KHR es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (BufferImageCopy2KHR es)

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: BufferImageCopy2KHR es

data ImageResolve2KHR

VkImageResolve2KHR - Structure specifying an image resolve operation

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must only contain IMAGE_ASPECT_COLOR_BIT

• The layerCount member of srcSubresource and dstSubresource must match

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_RESOLVE_2_KHR

• pNext must be NULL
• srcSubresource must be a valid ImageSubresourceLayers structure
• dstSubresource must be a valid ImageSubresourceLayers structure

See Also

VK_KHR_copy_commands2, Extent3D, ImageSubresourceLayers, Offset3D, ResolveImageInfo2KHR, StructureType

Constructors

ImageResolve2KHR

Fields

• srcSubresource :: ImageSubresourceLayers

  srcSubresource and dstSubresource are ImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively. Resolve of depth/stencil images is not supported.

• srcOffset :: Offset3D

  srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.

• dstSubresource :: ImageSubresourceLayers
• dstOffset :: Offset3D
• extent :: Extent3D

  extent is the size in texels of the source image to resolve in width, height and depth.

Instances

Show ImageResolve2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> ImageResolve2KHR -> ShowS

show :: ImageResolve2KHR -> String

showList :: [ImageResolve2KHR] -> ShowS

Storable ImageResolve2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

sizeOf :: ImageResolve2KHR -> Int

alignment :: ImageResolve2KHR -> Int

peekElemOff :: Ptr ImageResolve2KHR -> Int -> IO ImageResolve2KHR

pokeElemOff :: Ptr ImageResolve2KHR -> Int -> ImageResolve2KHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImageResolve2KHR

pokeByteOff :: Ptr b -> Int -> ImageResolve2KHR -> IO ()

peek :: Ptr ImageResolve2KHR -> IO ImageResolve2KHR

poke :: Ptr ImageResolve2KHR -> ImageResolve2KHR -> IO ()

FromCStruct ImageResolve2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr ImageResolve2KHR -> IO ImageResolve2KHR

ToCStruct ImageResolve2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: ImageResolve2KHR -> (Ptr ImageResolve2KHR -> IO b) -> IO b

pokeCStruct :: Ptr ImageResolve2KHR -> ImageResolve2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr ImageResolve2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageResolve2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageResolve2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: ImageResolve2KHR

data CopyBufferInfo2KHR

VkCopyBufferInfo2KHR - Structure specifying parameters of a buffer copy command

Description

Members defined by this structure with the same name as parameters in cmdCopyBuffer have the identical effect to those parameters; the child structure BufferCopy2KHR is a variant of BufferCopy which includes sType and pNext parameters, allowing it to be extended.

Valid Usage

• The srcOffset member of each element of pRegions must be less than the size of srcBuffer

• The dstOffset member of each element of pRegions must be less than the size of dstBuffer
• The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
• The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
• The union of the source regions, and the union of the destination regions, specified by the elements of pRegions, must not overlap in memory
• srcBuffer must have been created with BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
• If srcBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstBuffer must have been created with BUFFER_USAGE_TRANSFER_DST_BIT usage flag
• If dstBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_BUFFER_INFO_2_KHR

• pNext must be NULL
• srcBuffer must be a valid Buffer handle
• dstBuffer must be a valid Buffer handle
• pRegions must be a valid pointer to an array of regionCount valid BufferCopy2KHR structures
• regionCount must be greater than 0
• Both of dstBuffer, and srcBuffer must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Buffer, BufferCopy2KHR, StructureType, cmdCopyBuffer2KHR

Constructors

CopyBufferInfo2KHR

Fields

• srcBuffer :: Buffer

  srcBuffer is the source buffer.

• dstBuffer :: Buffer

  dstBuffer is the destination buffer.

• regions :: Vector BufferCopy2KHR

  pRegions is a pointer to an array of BufferCopy2KHR structures specifying the regions to copy.

Instances

Show CopyBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> CopyBufferInfo2KHR -> ShowS

show :: CopyBufferInfo2KHR -> String

showList :: [CopyBufferInfo2KHR] -> ShowS

FromCStruct CopyBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr CopyBufferInfo2KHR -> IO CopyBufferInfo2KHR

ToCStruct CopyBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: CopyBufferInfo2KHR -> (Ptr CopyBufferInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr CopyBufferInfo2KHR -> CopyBufferInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr CopyBufferInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr CopyBufferInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: CopyBufferInfo2KHR

data CopyImageInfo2KHR

VkCopyImageInfo2KHR - Structure specifying parameters of an image copy command

Valid Usage

• The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory

• The format features of srcImage must contain FORMAT_FEATURE_TRANSFER_SRC_BIT
• srcImage must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
• If srcImage is non-sparse then the image or disjoint plane to be copied must be bound completely and contiguously to a single DeviceMemory object
• srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a Device
• srcImageLayout must be IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• The format features of dstImage must contain FORMAT_FEATURE_TRANSFER_DST_BIT
• dstImage must have been created with IMAGE_USAGE_TRANSFER_DST_BIT usage flag
• If dstImage is non-sparse then the image or disjoint plane that is the destination of the copy must be bound completely and contiguously to a single DeviceMemory object
• dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a Device
• dstImageLayout must be IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• If the Format of each of srcImage and dstImage is not a multi-planar format, the Format of each of srcImage and dstImage must be compatible, as defined above
• In a copy to or from a plane of a multi-planar image, the Format of the image and plane must be compatible according to the description of compatible planes for the plane being copied
• The sample count of srcImage and dstImage must match
• The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• The 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
• The 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
• The srcOffset and extent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• The dstOffset and extent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• dstImage and srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If neither srcImage nor dstImage has a multi-planar image format then for each element of pRegions, srcSubresource.aspectMask and dstSubresource.aspectMask must match
• If srcImage has a Format with two planes then for each element of pRegions, srcSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT or IMAGE_ASPECT_PLANE_1_BIT
• If srcImage has a Format with three planes then for each element of pRegions, srcSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT
• If dstImage has a Format with two planes then for each element of pRegions, dstSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT or IMAGE_ASPECT_PLANE_1_BIT
• If dstImage has a Format with three planes then for each element of pRegions, dstSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT
• If srcImage has a multi-planar image format and the dstImage does not have a multi-planar image format, then for each element of pRegions, dstSubresource.aspectMask must be IMAGE_ASPECT_COLOR_BIT
• If dstImage has a multi-planar image format and the srcImage does not have a multi-planar image format, then for each element of pRegions, srcSubresource.aspectMask must be IMAGE_ASPECT_COLOR_BIT
• If srcImage is of type IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1
• If dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
• For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
• For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
• 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, then for each element of pRegions, srcOffset.z must be 0 and extent.depth must be 1
• If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, dstOffset.z must be 0 and extent.depth must be 1
• If srcImage is of type IMAGE_TYPE_2D, then for each element of pRegions, srcOffset.z must be 0
• If dstImage is of type IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0
• If srcImage and dstImage are both of type IMAGE_TYPE_2D, then for each element of pRegions, extent.depth must be 1
• If srcImage is of type IMAGE_TYPE_2D, and dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, extent.depth must equal srcSubresource.layerCount
• If dstImage is of type IMAGE_TYPE_2D, and srcImage is of type IMAGE_TYPE_3D, then for each element of pRegions, extent.depth must equal dstSubresource.layerCount
• 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 srcImage is a blocked image, then for each element of pRegions, all members of srcOffset must be a multiple of the corresponding dimensions of the compressed texel block
• If srcImage is a blocked image, then for each element of pRegions, extent.width must be a multiple of the compressed texel block width or (extent.width + srcOffset.x) must equal the width of the specified srcSubresource of srcImage
• If srcImage is a blocked image, then for each element of pRegions, extent.height must be a multiple of the compressed texel block height or (extent.height + srcOffset.y) must equal the height of the specified srcSubresource of srcImage
• If srcImage is a blocked image, then for each element of pRegions, extent.depth must be a multiple of the compressed texel block depth or (extent.depth + srcOffset.z) must equal the depth of the specified srcSubresource of srcImage
• If dstImage is a blocked image, then for each element of pRegions, all members of dstOffset must be a multiple of the corresponding dimensions of the compressed texel block
• If dstImage is a blocked image, then for each element of pRegions, extent.width must be a multiple of the compressed texel block width or (extent.width + dstOffset.x) must equal the width of the specified dstSubresource of dstImage
• If dstImage is a blocked image, then for each element of pRegions, extent.height must be a multiple of the compressed texel block height or (extent.height + dstOffset.y) must equal the height of the specified dstSubresource of dstImage
• If dstImage is a blocked image, then for each element of pRegions, extent.depth must be a multiple of the compressed texel block depth or (extent.depth + dstOffset.z) must equal the depth of the specified dstSubresource of dstImage

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_IMAGE_INFO_2_KHR

• pNext must be NULL
• 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 ImageCopy2KHR structures
• regionCount must be greater than 0
• Both of dstImage, and srcImage must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Image, ImageCopy2KHR, ImageLayout, StructureType, cmdCopyImage2KHR

Constructors

CopyImageInfo2KHR

Fields

• srcImage :: Image

  srcImage is the source image.

• srcImageLayout :: ImageLayout

  srcImageLayout is the current layout of the source image subresource.

• dstImage :: Image

  dstImage is the destination image.

• dstImageLayout :: ImageLayout

  dstImageLayout is the current layout of the destination image subresource.

• regions :: Vector ImageCopy2KHR

  pRegions is a pointer to an array of ImageCopy2KHR structures specifying the regions to copy.

Instances

Show CopyImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> CopyImageInfo2KHR -> ShowS

show :: CopyImageInfo2KHR -> String

showList :: [CopyImageInfo2KHR] -> ShowS

FromCStruct CopyImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr CopyImageInfo2KHR -> IO CopyImageInfo2KHR

ToCStruct CopyImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: CopyImageInfo2KHR -> (Ptr CopyImageInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr CopyImageInfo2KHR -> CopyImageInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr CopyImageInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr CopyImageInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: CopyImageInfo2KHR

data BlitImageInfo2KHR

VkBlitImageInfo2KHR - Structure specifying parameters of blit image command

Valid Usage

• The source region specified by each element of pRegions must be a region that is contained within srcImage

• The destination region specified by each element of pRegions must be a region that is contained within dstImage
• The union of all destination regions, specified by the elements of pRegions, must not overlap in memory with any texel that may be sampled during the blit operation
• The format features of srcImage must contain FORMAT_FEATURE_BLIT_SRC_BIT
• srcImage must not use a format that requires a sampler Y’CBCR conversion
• srcImage must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
• If srcImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a Device
• srcImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or IMAGE_LAYOUT_GENERAL
• The format features of dstImage must contain FORMAT_FEATURE_BLIT_DST_BIT
• dstImage must not use a format that requires a sampler Y’CBCR conversion
• dstImage must have been created with IMAGE_USAGE_TRANSFER_DST_BIT usage flag
• If dstImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a Device
• dstImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or IMAGE_LAYOUT_GENERAL
• If either of srcImage or dstImage was created with a signed integer Format, the other must also have been created with a signed integer Format
• If either of srcImage or dstImage was created with an unsigned integer Format, the other must also have been created with an unsigned integer Format
• If either of srcImage or dstImage was created with a depth/stencil format, the other must have exactly the same format
• If srcImage was created with a depth/stencil format, filter must be FILTER_NEAREST
• srcImage must have been created with a samples value of SAMPLE_COUNT_1_BIT
• dstImage must have been created with a samples value of SAMPLE_COUNT_1_BIT
• If filter is FILTER_LINEAR, then the format features of srcImage must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If filter is FILTER_CUBIC_EXT, then the format features of srcImage must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• If filter is FILTER_CUBIC_EXT, srcImage must be of type IMAGE_TYPE_2D
• The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• The 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
• The 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 and srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If either srcImage or dstImage is of type IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer and dstSubresource.baseArrayLayer must each be 0, and srcSubresource.layerCount and dstSubresource.layerCount must each be 1
• For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
• For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
• For each element of pRegions, srcOffsets[0].x and srcOffsets[1].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, srcOffsets[0].y and srcOffsets[1].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, srcOffsets[0].y must be 0 and srcOffsets[1].y must be 1
• For each element of pRegions, srcOffsets[0].z and srcOffsets[1].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, srcOffsets[0].z must be 0 and srcOffsets[1].z must be 1
• For each element of pRegions, dstOffsets[0].x and dstOffsets[1].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, dstOffsets[0].y and dstOffsets[1].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, dstOffsets[0].y must be 0 and dstOffsets[1].y must be 1
• For each element of pRegions, dstOffsets[0].z and dstOffsets[1].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, dstOffsets[0].z must be 0 and dstOffsets[1].z must be 1
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage and dstImage must not be block-compressed images
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage must be of type IMAGE_TYPE_2D
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage must not have a multi-planar format

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BLIT_IMAGE_INFO_2_KHR

• pNext must be NULL
• 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 ImageBlit2KHR structures
• filter must be a valid Filter value
• regionCount must be greater than 0
• Both of dstImage, and srcImage must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Filter, Image, ImageBlit2KHR, ImageLayout, StructureType, cmdBlitImage2KHR

Constructors

BlitImageInfo2KHR

Fields

• srcImage :: Image

  srcImage is the source image.

• srcImageLayout :: ImageLayout

  srcImageLayout is the layout of the source image subresources for the blit.

• dstImage :: Image

  dstImage is the destination image.

• dstImageLayout :: ImageLayout

  dstImageLayout is the layout of the destination image subresources for the blit.

• regions :: Vector (SomeStruct ImageBlit2KHR)

  pRegions is a pointer to an array of ImageBlit2KHR structures specifying the regions to blit.

• filter' :: Filter

  filter is a Filter specifying the filter to apply if the blits require scaling.

Instances

Show BlitImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> BlitImageInfo2KHR -> ShowS

show :: BlitImageInfo2KHR -> String

showList :: [BlitImageInfo2KHR] -> ShowS

FromCStruct BlitImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr BlitImageInfo2KHR -> IO BlitImageInfo2KHR

ToCStruct BlitImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: BlitImageInfo2KHR -> (Ptr BlitImageInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr BlitImageInfo2KHR -> BlitImageInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr BlitImageInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr BlitImageInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BlitImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: BlitImageInfo2KHR

data CopyBufferToImageInfo2KHR

VkCopyBufferToImageInfo2KHR - Structure specifying parameters of a buffer to image copy command

Valid Usage

• If the image region specified by each element of pRegions does not contain CopyCommandTransformInfoQCOM in its pNext chain, it must be a region that is contained within the specified imageSubresource of dstImage

• If the image region specified by each element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, the rotated destination region as described in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#copies-buffers-images-rotation-addressing must be contained within dstImage
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then dstImage must not be a blocked image
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then dstImage must be of type IMAGE_TYPE_2D
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then dstImage must not have a multi-planar format
• srcBuffer must be large enough to contain all buffer 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
• srcBuffer must have been created with BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
• The format features of dstImage must contain FORMAT_FEATURE_TRANSFER_DST_BIT
• If srcBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstImage must have been created with IMAGE_USAGE_TRANSFER_DST_BIT usage flag
• If dstImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a Device
• dstImageLayout must be IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• The 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
• The imageOffset and imageExtent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, for each element of pRegions, the aspectMask member of imageSubresource must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• For each element of pRegions not containing CopyCommandTransformInfoQCOM in its pNext chain, 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 not containing CopyCommandTransformInfoQCOM in its pNext chain, 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
• If dstImage does not have either a depth/stencil or a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the format’s texel block size
• If dstImage has a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the element size of the compatible format for the format and the aspectMask of the imageSubresource as defined in ???
• 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
• If dstImage is a blocked image, for each element of pRegions, bufferRowLength must be a multiple of the compressed texel block width
• If dstImage is a blocked image, for each element of pRegions, bufferImageHeight must be a multiple of the compressed texel block height
• If dstImage is a blocked image, for each element of pRegions, all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
• If dstImage is a blocked image, for each element of pRegions, bufferOffset must be a multiple of the compressed texel block size in bytes
• If dstImage is a blocked image, for each element of pRegions, imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x) must equal the width of the specified imageSubresource of dstImage
• If dstImage is a blocked image, for each element of pRegions, imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y) must equal the height of the specified imageSubresource of dstImage
• If dstImage is a blocked image, for each element of pRegions, imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z) must equal the depth of the specified imageSubresource of dstImage
• For each element of pRegions, imageSubresource.aspectMask must specify aspects present in dstImage
• If dstImage has a multi-planar format, then for each element of pRegions, imageSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT (with IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes)
• If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
• If dstImage is not a blocked image, for each element of pRegions, bufferRowLength multiplied by the texel block size of dstImage must be less than or equal to 231-1
• If dstImage is a blocked image, for each element of pRegions, bufferRowLength divided by the compressed texel block width and then multiplied by the texel block size of dstImage must be less than or equal to 231-1
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT, the bufferOffset member of any element of pRegions must be a multiple of 4
• If dstImage has a depth/stencil format, the bufferOffset member of any element of pRegions must be a multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_BUFFER_TO_IMAGE_INFO_2_KHR

• pNext must be NULL
• srcBuffer must be a valid Buffer handle
• 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 BufferImageCopy2KHR structures
• regionCount must be greater than 0
• Both of dstImage, and srcBuffer must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Buffer, BufferImageCopy2KHR, Image, ImageLayout, StructureType, cmdCopyBufferToImage2KHR

Constructors

CopyBufferToImageInfo2KHR

Fields

• srcBuffer :: Buffer

  srcBuffer is the source buffer.

• dstImage :: Image

  dstImage is the destination image.

• dstImageLayout :: ImageLayout

  dstImageLayout is the layout of the destination image subresources for the copy.

• regions :: Vector (SomeStruct BufferImageCopy2KHR)

  pRegions is a pointer to an array of BufferImageCopy2KHR structures specifying the regions to copy.

Instances

Show CopyBufferToImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> CopyBufferToImageInfo2KHR -> ShowS

show :: CopyBufferToImageInfo2KHR -> String

showList :: [CopyBufferToImageInfo2KHR] -> ShowS

FromCStruct CopyBufferToImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr CopyBufferToImageInfo2KHR -> IO CopyBufferToImageInfo2KHR

ToCStruct CopyBufferToImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: CopyBufferToImageInfo2KHR -> (Ptr CopyBufferToImageInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr CopyBufferToImageInfo2KHR -> CopyBufferToImageInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr CopyBufferToImageInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr CopyBufferToImageInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyBufferToImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: CopyBufferToImageInfo2KHR

data CopyImageToBufferInfo2KHR

VkCopyImageToBufferInfo2KHR - Structure specifying parameters of an image to buffer copy command

Valid Usage

• If the image region specified by each element of pRegions does not contain CopyCommandTransformInfoQCOM in its pNext chain, it must be contained within the specified imageSubresource of srcImage

• If the image region specified by each element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, the rotated source region as described in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#copies-buffers-images-rotation-addressing must be contained within srcImage
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage must not be a blocked image
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage must be of type IMAGE_TYPE_2D
• If any element of pRegions contains CopyCommandTransformInfoQCOM in its pNext chain, then srcImage must not have a multi-planar format
• dstBuffer must be large enough to contain all buffer 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
• srcImage must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
• The format features of srcImage must contain FORMAT_FEATURE_TRANSFER_SRC_BIT
• If srcImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstBuffer must have been created with BUFFER_USAGE_TRANSFER_DST_BIT usage flag
• If dstBuffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• srcImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a Device
• srcImageLayout must be IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• The 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
• The imageOffset and imageExtent members of each element of pRegions must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in QueueFamilyProperties
• srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• For each element of pRegions not containing CopyCommandTransformInfoQCOM in its pNext chain, 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 not containing CopyCommandTransformInfoQCOM in its pNext chain, 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
• If {imageparam} does not have either a depth/stencil or a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the format’s texel block size
• If {imageparam} has a multi-planar format, then for each element of pRegions, bufferOffset must be a multiple of the element size of the compatible format for the format and the aspectMask of the imageSubresource as defined in ???
• If {imageparam} 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 {imageparam}
• If {imageparam} 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
• If {imageparam} is a blocked image, for each element of pRegions, bufferRowLength must be a multiple of the compressed texel block width
• If {imageparam} is a blocked image, for each element of pRegions, bufferImageHeight must be a multiple of the compressed texel block height
• If {imageparam} is a blocked image, for each element of pRegions, all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
• If {imageparam} is a blocked image, for each element of pRegions, bufferOffset must be a multiple of the compressed texel block size in bytes
• If {imageparam} is a blocked image, for each element of pRegions, imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x) must equal the width of the specified imageSubresource of {imageparam}
• If {imageparam} is a blocked image, for each element of pRegions, imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y) must equal the height of the specified imageSubresource of {imageparam}
• If {imageparam} is a blocked image, for each element of pRegions, imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z) must equal the depth of the specified imageSubresource of {imageparam}
• For each element of pRegions, imageSubresource.aspectMask must specify aspects present in {imageparam}
• If {imageparam} has a multi-planar format, then for each element of pRegions, imageSubresource.aspectMask must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT (with IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes)
• If {imageparam} is of type IMAGE_TYPE_3D, for each element of pRegions, imageSubresource.baseArrayLayer must be 0 and imageSubresource.layerCount must be 1
• If {imageparam} is not a blocked image, for each element of pRegions, bufferRowLength multiplied by the texel block size of {imageparam} must be less than or equal to 231-1
• If {imageparam} is a blocked image, for each element of pRegions, bufferRowLength divided by the compressed texel block width and then multiplied by the texel block size of {imageparam} must be less than or equal to 231-1
• If the queue family used to create the CommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT, the bufferOffset member of any element of pRegions must be a multiple of 4
• If {imageparam} has a depth/stencil format, the bufferOffset member of any element of pRegions must be a multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2_KHR

• pNext must be NULL
• srcImage must be a valid Image handle
• srcImageLayout must be a valid ImageLayout value
• dstBuffer must be a valid Buffer handle
• pRegions must be a valid pointer to an array of regionCount valid BufferImageCopy2KHR structures
• regionCount must be greater than 0
• Both of dstBuffer, and srcImage must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Buffer, BufferImageCopy2KHR, Image, ImageLayout, StructureType, cmdCopyImageToBuffer2KHR

Constructors

CopyImageToBufferInfo2KHR

Fields

• srcImage :: Image

  srcImage is the source image.

• srcImageLayout :: ImageLayout

  srcImageLayout is the layout of the source image subresources for the copy.

• dstBuffer :: Buffer

  dstBuffer is the destination buffer.

• regions :: Vector (SomeStruct BufferImageCopy2KHR)

  pRegions is a pointer to an array of BufferImageCopy2KHR structures specifying the regions to copy.

Instances

Show CopyImageToBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> CopyImageToBufferInfo2KHR -> ShowS

show :: CopyImageToBufferInfo2KHR -> String

showList :: [CopyImageToBufferInfo2KHR] -> ShowS

FromCStruct CopyImageToBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr CopyImageToBufferInfo2KHR -> IO CopyImageToBufferInfo2KHR

ToCStruct CopyImageToBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: CopyImageToBufferInfo2KHR -> (Ptr CopyImageToBufferInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr CopyImageToBufferInfo2KHR -> CopyImageToBufferInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr CopyImageToBufferInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr CopyImageToBufferInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CopyImageToBufferInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: CopyImageToBufferInfo2KHR

data ResolveImageInfo2KHR

VkResolveImageInfo2KHR - Structure specifying parameters of resolve image command

Valid Usage

• The union of all source regions, and the union of all destination regions, specified by the elements of pRegions, must not overlap in memory

• If srcImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• srcImage must have a sample count equal to any valid sample count value other than SAMPLE_COUNT_1_BIT
• If dstImage is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• srcImageLayout must specify the layout of the image subresources of srcImage specified in pRegions at the time this command is executed on a Device
• srcImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or IMAGE_LAYOUT_GENERAL
• dstImageLayout must specify the layout of the image subresources of dstImage specified in pRegions at the time this command is executed on a Device
• dstImageLayout must be IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or IMAGE_LAYOUT_GENERAL
• The format features of dstImage must contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
• srcImage and dstImage must have been created with the same image format
• The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when srcImage was created
• The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in ImageCreateInfo when dstImage was created
• The 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
• The 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 and srcImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If either srcImage or dstImage are of type IMAGE_TYPE_3D, then for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1
• If either srcImage or dstImage are of type IMAGE_TYPE_3D, then for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
• 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, 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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2_KHR

• pNext must be NULL
• 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 ImageResolve2KHR structures
• regionCount must be greater than 0
• Both of dstImage, and srcImage must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_copy_commands2, Image, ImageLayout, ImageResolve2KHR, StructureType, cmdResolveImage2KHR

Constructors

ResolveImageInfo2KHR

Fields

• srcImage :: Image

  srcImage is the source image.

• srcImageLayout :: ImageLayout

  srcImageLayout is the layout of the source image subresources for the resolve.

• dstImage :: Image

  dstImage is the destination image.

• dstImageLayout :: ImageLayout

  dstImageLayout is the layout of the destination image subresources for the resolve.

• regions :: Vector ImageResolve2KHR

  pRegions is a pointer to an array of ImageResolve2KHR structures specifying the regions to resolve.

Instances

Show ResolveImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

showsPrec :: Int -> ResolveImageInfo2KHR -> ShowS

show :: ResolveImageInfo2KHR -> String

showList :: [ResolveImageInfo2KHR] -> ShowS

FromCStruct ResolveImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

peekCStruct :: Ptr ResolveImageInfo2KHR -> IO ResolveImageInfo2KHR

ToCStruct ResolveImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

withCStruct :: ResolveImageInfo2KHR -> (Ptr ResolveImageInfo2KHR -> IO b) -> IO b

pokeCStruct :: Ptr ResolveImageInfo2KHR -> ResolveImageInfo2KHR -> IO b -> IO b

withZeroCStruct :: (Ptr ResolveImageInfo2KHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr ResolveImageInfo2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ResolveImageInfo2KHR

Defined in Vulkan.Extensions.VK_KHR_copy_commands2

Methods

zero :: ResolveImageInfo2KHR

type KHR_COPY_COMMANDS_2_SPEC_VERSION = 1

pattern KHR_COPY_COMMANDS_2_SPEC_VERSION :: forall a. Integral a => a

type KHR_COPY_COMMANDS_2_EXTENSION_NAME = "VK_KHR_copy_commands2"

pattern KHR_COPY_COMMANDS_2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a