Graphics.Vulkan.Core10.SparseResourceMemoryManagement

Documentation

newtype VkImageAspectFlagBits

VkImageAspectFlagBits - Bitmask specifying which aspects of an image are included in a view

See Also

VkBindImagePlaneMemoryInfo, VkImageAspectFlags, VkImagePlaneMemoryRequirementsInfo

Constructors

VkImageAspectFlagBits VkFlags

Instances

Eq VkImageAspectFlagBits

Methods

(==) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

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

Ord VkImageAspectFlagBits

Methods

compare :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Ordering

(<) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

(<=) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

(>) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

(>=) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

max :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

min :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

Read VkImageAspectFlagBits

Methods

readsPrec :: Int -> ReadS VkImageAspectFlagBits

readList :: ReadS [VkImageAspectFlagBits]

readPrec :: ReadPrec VkImageAspectFlagBits

readListPrec :: ReadPrec [VkImageAspectFlagBits]

Show VkImageAspectFlagBits

Methods

showsPrec :: Int -> VkImageAspectFlagBits -> ShowS

show :: VkImageAspectFlagBits -> String

showList :: [VkImageAspectFlagBits] -> ShowS

Storable VkImageAspectFlagBits

Methods

sizeOf :: VkImageAspectFlagBits -> Int

alignment :: VkImageAspectFlagBits -> Int

peekElemOff :: Ptr VkImageAspectFlagBits -> Int -> IO VkImageAspectFlagBits

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

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

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

peek :: Ptr VkImageAspectFlagBits -> IO VkImageAspectFlagBits

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

Bits VkImageAspectFlagBits

Methods

(.&.) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

(.|.) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

xor :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

complement :: VkImageAspectFlagBits -> VkImageAspectFlagBits

shift :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotate :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

zeroBits :: VkImageAspectFlagBits

bit :: Int -> VkImageAspectFlagBits

setBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

clearBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

complementBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

testBit :: VkImageAspectFlagBits -> Int -> Bool

bitSizeMaybe :: VkImageAspectFlagBits -> Maybe Int

bitSize :: VkImageAspectFlagBits -> Int

isSigned :: VkImageAspectFlagBits -> Bool

shiftL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

unsafeShiftL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

shiftR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

unsafeShiftR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotateL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotateR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

popCount :: VkImageAspectFlagBits -> Int

FiniteBits VkImageAspectFlagBits

Methods

finiteBitSize :: VkImageAspectFlagBits -> Int

countLeadingZeros :: VkImageAspectFlagBits -> Int

countTrailingZeros :: VkImageAspectFlagBits -> Int

pattern VK_IMAGE_ASPECT_COLOR_BIT :: VkImageAspectFlagBits

VK_IMAGE_ASPECT_COLOR_BIT specifies the color aspect.

pattern VK_IMAGE_ASPECT_DEPTH_BIT :: VkImageAspectFlagBits

VK_IMAGE_ASPECT_DEPTH_BIT specifies the depth aspect.

pattern VK_IMAGE_ASPECT_STENCIL_BIT :: VkImageAspectFlagBits

VK_IMAGE_ASPECT_STENCIL_BIT specifies the stencil aspect.

pattern VK_IMAGE_ASPECT_METADATA_BIT :: VkImageAspectFlagBits

VK_IMAGE_ASPECT_METADATA_BIT specifies the metadata aspect, used for sparse sparse resource operations.

newtype VkSparseMemoryBindFlagBits

VkSparseMemoryBindFlagBits - Bitmask specifying usage of a sparse memory binding operation

See Also

VkSparseMemoryBindFlags

Constructors

VkSparseMemoryBindFlagBits VkFlags

Instances

Eq VkSparseMemoryBindFlagBits

Methods

(==) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Bool

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

Ord VkSparseMemoryBindFlagBits

Methods

compare :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Ordering

(<) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Bool

(<=) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Bool

(>) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Bool

(>=) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> Bool

max :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

min :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

Read VkSparseMemoryBindFlagBits

Methods

readsPrec :: Int -> ReadS VkSparseMemoryBindFlagBits

readList :: ReadS [VkSparseMemoryBindFlagBits]

readPrec :: ReadPrec VkSparseMemoryBindFlagBits

readListPrec :: ReadPrec [VkSparseMemoryBindFlagBits]

Show VkSparseMemoryBindFlagBits

Methods

showsPrec :: Int -> VkSparseMemoryBindFlagBits -> ShowS

show :: VkSparseMemoryBindFlagBits -> String

showList :: [VkSparseMemoryBindFlagBits] -> ShowS

Storable VkSparseMemoryBindFlagBits

Methods

sizeOf :: VkSparseMemoryBindFlagBits -> Int

alignment :: VkSparseMemoryBindFlagBits -> Int

peekElemOff :: Ptr VkSparseMemoryBindFlagBits -> Int -> IO VkSparseMemoryBindFlagBits

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

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

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

peek :: Ptr VkSparseMemoryBindFlagBits -> IO VkSparseMemoryBindFlagBits

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

Bits VkSparseMemoryBindFlagBits

Methods

(.&.) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

(.|.) :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

xor :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

complement :: VkSparseMemoryBindFlagBits -> VkSparseMemoryBindFlagBits

shift :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

rotate :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

zeroBits :: VkSparseMemoryBindFlagBits

bit :: Int -> VkSparseMemoryBindFlagBits

setBit :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

clearBit :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

complementBit :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

testBit :: VkSparseMemoryBindFlagBits -> Int -> Bool

bitSizeMaybe :: VkSparseMemoryBindFlagBits -> Maybe Int

bitSize :: VkSparseMemoryBindFlagBits -> Int

isSigned :: VkSparseMemoryBindFlagBits -> Bool

shiftL :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

unsafeShiftL :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

shiftR :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

unsafeShiftR :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

rotateL :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

rotateR :: VkSparseMemoryBindFlagBits -> Int -> VkSparseMemoryBindFlagBits

popCount :: VkSparseMemoryBindFlagBits -> Int

FiniteBits VkSparseMemoryBindFlagBits

Methods

finiteBitSize :: VkSparseMemoryBindFlagBits -> Int

countLeadingZeros :: VkSparseMemoryBindFlagBits -> Int

countTrailingZeros :: VkSparseMemoryBindFlagBits -> Int

pattern VK_SPARSE_MEMORY_BIND_METADATA_BIT :: VkSparseMemoryBindFlagBits

VK_SPARSE_MEMORY_BIND_METADATA_BIT specifies that the memory being bound is only for the metadata aspect.

newtype VkSparseImageFormatFlagBits

VkSparseImageFormatFlagBits - Bitmask specifying additional information about a sparse image resource

See Also

VkSparseImageFormatFlags

Constructors

VkSparseImageFormatFlagBits VkFlags

Instances

Eq VkSparseImageFormatFlagBits

Methods

(==) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Bool

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

Ord VkSparseImageFormatFlagBits

Methods

compare :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Ordering

(<) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Bool

(<=) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Bool

(>) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Bool

(>=) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> Bool

max :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

min :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

Read VkSparseImageFormatFlagBits

Methods

readsPrec :: Int -> ReadS VkSparseImageFormatFlagBits

readList :: ReadS [VkSparseImageFormatFlagBits]

readPrec :: ReadPrec VkSparseImageFormatFlagBits

readListPrec :: ReadPrec [VkSparseImageFormatFlagBits]

Show VkSparseImageFormatFlagBits

Methods

showsPrec :: Int -> VkSparseImageFormatFlagBits -> ShowS

show :: VkSparseImageFormatFlagBits -> String

showList :: [VkSparseImageFormatFlagBits] -> ShowS

Storable VkSparseImageFormatFlagBits

Methods

sizeOf :: VkSparseImageFormatFlagBits -> Int

alignment :: VkSparseImageFormatFlagBits -> Int

peekElemOff :: Ptr VkSparseImageFormatFlagBits -> Int -> IO VkSparseImageFormatFlagBits

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

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

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

peek :: Ptr VkSparseImageFormatFlagBits -> IO VkSparseImageFormatFlagBits

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

Bits VkSparseImageFormatFlagBits

Methods

(.&.) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

(.|.) :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

xor :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

complement :: VkSparseImageFormatFlagBits -> VkSparseImageFormatFlagBits

shift :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

rotate :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

zeroBits :: VkSparseImageFormatFlagBits

bit :: Int -> VkSparseImageFormatFlagBits

setBit :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

clearBit :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

complementBit :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

testBit :: VkSparseImageFormatFlagBits -> Int -> Bool

bitSizeMaybe :: VkSparseImageFormatFlagBits -> Maybe Int

bitSize :: VkSparseImageFormatFlagBits -> Int

isSigned :: VkSparseImageFormatFlagBits -> Bool

shiftL :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

unsafeShiftL :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

shiftR :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

unsafeShiftR :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

rotateL :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

rotateR :: VkSparseImageFormatFlagBits -> Int -> VkSparseImageFormatFlagBits

popCount :: VkSparseImageFormatFlagBits -> Int

FiniteBits VkSparseImageFormatFlagBits

Methods

finiteBitSize :: VkSparseImageFormatFlagBits -> Int

countLeadingZeros :: VkSparseImageFormatFlagBits -> Int

countTrailingZeros :: VkSparseImageFormatFlagBits -> Int

pattern VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT :: VkSparseImageFormatFlagBits

VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT specifies that the image uses a single mip tail region for all array layers.

pattern VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT :: VkSparseImageFormatFlagBits

VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT specifies that the first mip level whose dimensions are not integer multiples of the corresponding dimensions of the sparse image block begins the mip tail region.

pattern VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT :: VkSparseImageFormatFlagBits

VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT specifies that the image uses non-standard sparse image block dimensions, and the imageGranularity values do not match the standard sparse image block dimensions for the given format.

vkGetImageSparseMemoryRequirements :: ("device" ::: VkDevice) -> ("image" ::: VkImage) -> ("pSparseMemoryRequirementCount" ::: Ptr Word32) -> ("pSparseMemoryRequirements" ::: Ptr VkSparseImageMemoryRequirements) -> IO ()

vkGetImageSparseMemoryRequirements - Query the memory requirements for a sparse image

Parameters

• device is the logical device that owns the image.

• image is the VkImage object to get the memory requirements for.
• pSparseMemoryRequirementCount is a pointer to an integer related to the number of sparse memory requirements available or queried, as described below.
• pSparseMemoryRequirements is either NULL or a pointer to an array of VkSparseImageMemoryRequirements structures.

Description

If pSparseMemoryRequirements is NULL, then the number of sparse memory requirements available is returned in pSparseMemoryRequirementCount. Otherwise, pSparseMemoryRequirementCount must point to a variable set by the user to the number of elements in the pSparseMemoryRequirements array, and on return the variable is overwritten with the number of structures actually written to pSparseMemoryRequirements. If pSparseMemoryRequirementCount is less than the number of sparse memory requirements available, at most pSparseMemoryRequirementCount structures will be written.

If the image was not created with VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT then pSparseMemoryRequirementCount will be set to zero and pSparseMemoryRequirements will not be written to.

Note

It is legal for an implementation to report a larger value in VkMemoryRequirements::size than would be obtained by adding together memory sizes for all VkSparseImageMemoryRequirements returned by vkGetImageSparseMemoryRequirements. This may occur when the implementation requires unused padding in the address range describing the resource.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• image must be a valid VkImage handle
• pSparseMemoryRequirementCount must be a valid pointer to a uint32_t value
• If the value referenced by pSparseMemoryRequirementCount is not 0, and pSparseMemoryRequirements is not NULL, pSparseMemoryRequirements must be a valid pointer to an array of pSparseMemoryRequirementCount VkSparseImageMemoryRequirements structures
• image must have been created, allocated, or retrieved from device

See Also

VkDevice, VkImage, VkSparseImageMemoryRequirements

vkGetPhysicalDeviceSparseImageFormatProperties :: ("physicalDevice" ::: VkPhysicalDevice) -> ("format" ::: VkFormat) -> ("type" ::: VkImageType) -> ("samples" ::: VkSampleCountFlagBits) -> ("usage" ::: VkImageUsageFlags) -> ("tiling" ::: VkImageTiling) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkSparseImageFormatProperties) -> IO ()

vkGetPhysicalDeviceSparseImageFormatProperties - Retrieve properties of an image format applied to sparse images

Parameters

• physicalDevice is the physical device from which to query the sparse image capabilities.

• format is the image format.
• type is the dimensionality of image.
• samples is the number of samples per texel as defined in VkSampleCountFlagBits.
• usage is a bitmask describing the intended usage of the image.
• tiling is the tiling arrangement of the data elements in memory.
• pPropertyCount is a pointer to an integer related to the number of sparse format properties available or queried, as described below.
• pProperties is either NULL or a pointer to an array of VkSparseImageFormatProperties structures.

Description

If pProperties is NULL, then the number of sparse format properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of sparse format properties available, at most pPropertyCount structures will be written.

If VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT is not supported for the given arguments, pPropertyCount will be set to zero upon return, and no data will be written to pProperties.

Multiple aspects are returned for depth/stencil images that are implemented as separate planes by the implementation. The depth and stencil data planes each have unique VkSparseImageFormatProperties data.

Depth/stencil images with depth and stencil data interleaved into a single plane will return a single VkSparseImageFormatProperties structure with the aspectMask set to VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT.

Valid Usage

• samples must be a bit value that is set in VkImageFormatProperties::sampleCounts returned by vkGetPhysicalDeviceImageFormatProperties with format, type, tiling, and usage equal to those in this command and flags equal to the value that is set in VkImageCreateInfo::flags when the image is created

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle

• format must be a valid VkFormat value
• type must be a valid VkImageType value
• samples must be a valid VkSampleCountFlagBits value
• usage must be a valid combination of VkImageUsageFlagBits values
• usage must not be 0
• tiling must be a valid VkImageTiling value
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkSparseImageFormatProperties structures

See Also

VkFormat, VkImageTiling, VkImageType, VkImageUsageFlags, VkPhysicalDevice, VkSampleCountFlagBits, VkSparseImageFormatProperties

vkQueueBindSparse :: ("queue" ::: VkQueue) -> ("bindInfoCount" ::: Word32) -> ("pBindInfo" ::: Ptr VkBindSparseInfo) -> ("fence" ::: VkFence) -> IO VkResult

vkQueueBindSparse - Bind device memory to a sparse resource object

Parameters

• queue is the queue that the sparse binding operations will be submitted to.

• bindInfoCount is the number of elements in the pBindInfo array.
• pBindInfo is an array of VkBindSparseInfo structures, each specifying a sparse binding submission batch.
• fence is an optional handle to a fence to be signaled. If fence is not VK_NULL_HANDLE, it defines a fence signal operation.

Description

vkQueueBindSparse is a queue submission command, with each batch defined by an element of pBindInfo as an instance of the VkBindSparseInfo structure. Batches begin execution in the order they appear in pBindInfo, but may complete out of order.

Within a batch, a given range of a resource must not be bound more than once. Across batches, if a range is to be bound to one allocation and offset and then to another allocation and offset, then the application must guarantee (usually using semaphores) that the binding operations are executed in the correct order, as well as to order binding operations against the execution of command buffer submissions.

As no operation to vkQueueBindSparse causes any pipeline stage to access memory, synchronization primitives used in this command effectively only define execution dependencies.

Additional information about fence and semaphore operation is described in the synchronization chapter.

Valid Usage

• If fence is not VK_NULL_HANDLE, fence must be unsignaled

• If fence is not VK_NULL_HANDLE, fence must not be associated with any other queue command that has not yet completed execution on that queue
• Each element of the pSignalSemaphores member of each element of pBindInfo must be unsignaled when the semaphore signal operation it defines is executed on the device
• When a semaphore unsignal operation defined by any element of the pWaitSemaphores member of any element of pBindInfo executes on queue, no other queue must be waiting on the same semaphore.
• All elements of the pWaitSemaphores member of all elements of pBindInfo must be semaphores that are signaled, or have semaphore signal operations previously submitted for execution.

Valid Usage (Implicit)

• queue must be a valid VkQueue handle

• If bindInfoCount is not 0, pBindInfo must be a valid pointer to an array of bindInfoCount valid VkBindSparseInfo structures
• If fence is not VK_NULL_HANDLE, fence must be a valid VkFence handle
• The queue must support sparse binding operations
• Both of fence, and queue that are valid handles must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

• Host access to queue must be externally synchronized

• Host access to pBindInfo[].pWaitSemaphores[] must be externally synchronized
• Host access to pBindInfo[].pSignalSemaphores[] must be externally synchronized
• Host access to pBindInfo[].pBufferBinds[].buffer must be externally synchronized
• Host access to pBindInfo[].pImageOpaqueBinds[].image must be externally synchronized
• Host access to pBindInfo[].pImageBinds[].image must be externally synchronized
• Host access to fence must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
-	-	SPARSE_BINDING	-

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

• VK_ERROR_DEVICE_LOST

See Also

VkBindSparseInfo, VkFence, VkQueue

data VkOffset3D

VkOffset3D - Structure specifying a three-dimensional offset

See Also

VkBufferImageCopy, VkImageBlit, VkImageCopy, VkImageResolve, VkSparseImageMemoryBind

Constructors

VkOffset3D

Fields

• vkX :: Int32

  x is the x offset.

• vkY :: Int32

  y is the y offset.

• vkZ :: Int32

  z is the z offset.

Instances

Eq VkOffset3D

Methods

(==) :: VkOffset3D -> VkOffset3D -> Bool

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

Show VkOffset3D

Methods

showsPrec :: Int -> VkOffset3D -> ShowS

show :: VkOffset3D -> String

showList :: [VkOffset3D] -> ShowS

Storable VkOffset3D

Methods

sizeOf :: VkOffset3D -> Int

alignment :: VkOffset3D -> Int

peekElemOff :: Ptr VkOffset3D -> Int -> IO VkOffset3D

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

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

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

peek :: Ptr VkOffset3D -> IO VkOffset3D

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

data VkSparseImageFormatProperties

VkSparseImageFormatProperties - Structure specifying sparse image format properties

See Also

VkExtent3D, VkImageAspectFlags, VkSparseImageFormatFlags, VkSparseImageFormatProperties2, VkSparseImageMemoryRequirements, vkGetPhysicalDeviceSparseImageFormatProperties

Constructors

VkSparseImageFormatProperties

Fields

• vkAspectMask :: VkImageAspectFlags

  aspectMask is a bitmask VkImageAspectFlagBits specifying which aspects of the image the properties apply to.

• vkImageGranularity :: VkExtent3D

  imageGranularity is the width, height, and depth of the sparse image block in texels or compressed texel blocks.

• vkFlags :: VkSparseImageFormatFlags

  flags is a bitmask of VkSparseImageFormatFlagBits specifying additional information about the sparse resource.

Instances

Eq VkSparseImageFormatProperties

Methods

(==) :: VkSparseImageFormatProperties -> VkSparseImageFormatProperties -> Bool

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

Show VkSparseImageFormatProperties

Methods

showsPrec :: Int -> VkSparseImageFormatProperties -> ShowS

show :: VkSparseImageFormatProperties -> String

showList :: [VkSparseImageFormatProperties] -> ShowS

Storable VkSparseImageFormatProperties

Methods

sizeOf :: VkSparseImageFormatProperties -> Int

alignment :: VkSparseImageFormatProperties -> Int

peekElemOff :: Ptr VkSparseImageFormatProperties -> Int -> IO VkSparseImageFormatProperties

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

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

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

peek :: Ptr VkSparseImageFormatProperties -> IO VkSparseImageFormatProperties

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

data VkSparseImageMemoryRequirements

VkSparseImageMemoryRequirements - Structure specifying sparse image memory requirements

Members

• formatProperties.aspectMask is the set of aspects of the image that this sparse memory requirement applies to. This will usually have a single aspect specified. However, depth/stencil images may have depth and stencil data interleaved in the same sparse block, in which case both VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT would be present.

• formatProperties.imageGranularity describes the dimensions of a single bindable sparse image block in texel units. For aspect VK_IMAGE_ASPECT_METADATA_BIT, all dimensions will be zero. All metadata is located in the mip tail region.

• formatProperties.flags is a bitmask of VkSparseImageFormatFlagBits:

  • If VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT is set the image uses a single mip tail region for all array layers.
  • If VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT is set the dimensions of mip levels must be integer multiples of the corresponding dimensions of the sparse image block for levels not located in the mip tail.
  • If VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT is set the image uses non-standard sparse image block dimensions. The formatProperties.imageGranularity values do not match the standard sparse image block dimension corresponding to the image’s format.
• imageMipTailFirstLod is the first mip level at which image subresources are included in the mip tail region.
• imageMipTailSize is the memory size (in bytes) of the mip tail region. If formatProperties.flags contains VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT, this is the size of the whole mip tail, otherwise this is the size of the mip tail of a single array layer. This value is guaranteed to be a multiple of the sparse block size in bytes.
• imageMipTailOffset is the opaque memory offset used with VkSparseImageOpaqueMemoryBindInfo to bind the mip tail region(s).
• imageMipTailStride is the offset stride between each array-layer’s mip tail, if formatProperties.flags does not contain VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT (otherwise the value is undefined).

See Also

VkDeviceSize, VkSparseImageFormatProperties, VkSparseImageMemoryRequirements2, vkGetImageSparseMemoryRequirements

Constructors

VkSparseImageMemoryRequirements

Fields

• vkFormatProperties :: VkSparseImageFormatProperties
• vkImageMipTailFirstLod :: Word32
• vkImageMipTailSize :: VkDeviceSize
• vkImageMipTailOffset :: VkDeviceSize
• vkImageMipTailStride :: VkDeviceSize

Instances

Eq VkSparseImageMemoryRequirements

Methods

(==) :: VkSparseImageMemoryRequirements -> VkSparseImageMemoryRequirements -> Bool

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

Show VkSparseImageMemoryRequirements

Methods

showsPrec :: Int -> VkSparseImageMemoryRequirements -> ShowS

show :: VkSparseImageMemoryRequirements -> String

showList :: [VkSparseImageMemoryRequirements] -> ShowS

Storable VkSparseImageMemoryRequirements

Methods

sizeOf :: VkSparseImageMemoryRequirements -> Int

alignment :: VkSparseImageMemoryRequirements -> Int

peekElemOff :: Ptr VkSparseImageMemoryRequirements -> Int -> IO VkSparseImageMemoryRequirements

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

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

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

peek :: Ptr VkSparseImageMemoryRequirements -> IO VkSparseImageMemoryRequirements

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

data VkImageSubresource

VkImageSubresource - Structure specifying a image subresource

Valid Usage (Implicit)

• aspectMask must be a valid combination of VkImageAspectFlagBits values

• aspectMask must not be 0

See Also

VkImageAspectFlags, VkSparseImageMemoryBind, vkGetImageSubresourceLayout

Constructors

VkImageSubresource

Fields

• vkAspectMask :: VkImageAspectFlags

  aspectMask is a VkImageAspectFlags selecting the image aspect.

• vkMipLevel :: Word32

  mipLevel selects the mipmap level.

• vkArrayLayer :: Word32

  arrayLayer selects the array layer.

Instances

Eq VkImageSubresource

Methods

(==) :: VkImageSubresource -> VkImageSubresource -> Bool

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

Show VkImageSubresource

Methods

showsPrec :: Int -> VkImageSubresource -> ShowS

show :: VkImageSubresource -> String

showList :: [VkImageSubresource] -> ShowS

Storable VkImageSubresource

Methods

sizeOf :: VkImageSubresource -> Int

alignment :: VkImageSubresource -> Int

peekElemOff :: Ptr VkImageSubresource -> Int -> IO VkImageSubresource

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

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

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

peek :: Ptr VkImageSubresource -> IO VkImageSubresource

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

data VkSparseMemoryBind

VkSparseMemoryBind - Structure specifying a sparse memory bind operation

Description

The binding range [resourceOffset, resourceOffset + size) has different constraints based on flags. If flags contains VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the mip tail region of the metadata aspect. This metadata region is defined by:

• metadataRegion = [base, base + imageMipTailSize)
• base = imageMipTailOffset + imageMipTailStride × n

and imageMipTailOffset, imageMipTailSize, and imageMipTailStride values are from the VkSparseImageMemoryRequirements corresponding to the metadata aspect of the image, and n is a valid array layer index for the image,

imageMipTailStride is considered to be zero for aspects where VkSparseImageMemoryRequirements::formatProperties.flags contains VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT.

If flags does not contain VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the range [0,VkMemoryRequirements::size).

Valid Usage

• If memory is not VK_NULL_HANDLE, memory and memoryOffset must match the memory requirements of the resource, as described in section {html_spec_relative}#resources-association

• If memory is not VK_NULL_HANDLE, memory must not have been created with a memory type that reports VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit set
• size must be greater than 0
• resourceOffset must be less than the size of the resource
• size must be less than or equal to the size of the resource minus resourceOffset
• memoryOffset must be less than the size of memory
• size must be less than or equal to the size of memory minus memoryOffset

Valid Usage (Implicit)

• If memory is not VK_NULL_HANDLE, memory must be a valid VkDeviceMemory handle

• flags must be a valid combination of VkSparseMemoryBindFlagBits values

See Also

VkDeviceMemory, VkDeviceSize, VkSparseBufferMemoryBindInfo, VkSparseImageOpaqueMemoryBindInfo, VkSparseMemoryBindFlags

Constructors

VkSparseMemoryBind

Fields

• vkResourceOffset :: VkDeviceSize

  resourceOffset is the offset into the resource.

• vkSize :: VkDeviceSize

  size is the size of the memory region to be bound.

• vkMemory :: VkDeviceMemory

  memory is the VkDeviceMemory object that the range of the resource is bound to. If memory is VK_NULL_HANDLE, the range is unbound.

• vkMemoryOffset :: VkDeviceSize

  memoryOffset is the offset into the VkDeviceMemory object to bind the resource range to. If memory is VK_NULL_HANDLE, this value is ignored.

• vkFlags :: VkSparseMemoryBindFlags

  flags is a bitmask of VkSparseMemoryBindFlagBits specifying usage of the binding operation.

Instances

Eq VkSparseMemoryBind

Methods

(==) :: VkSparseMemoryBind -> VkSparseMemoryBind -> Bool

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

Show VkSparseMemoryBind

Methods

showsPrec :: Int -> VkSparseMemoryBind -> ShowS

show :: VkSparseMemoryBind -> String

showList :: [VkSparseMemoryBind] -> ShowS

Storable VkSparseMemoryBind

Methods

sizeOf :: VkSparseMemoryBind -> Int

alignment :: VkSparseMemoryBind -> Int

peekElemOff :: Ptr VkSparseMemoryBind -> Int -> IO VkSparseMemoryBind

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

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

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

peek :: Ptr VkSparseMemoryBind -> IO VkSparseMemoryBind

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

data VkSparseImageMemoryBind

VkSparseImageMemoryBind - Structure specifying sparse image memory bind

Valid Usage

• If the sparse aliased residency feature is not enabled, and if any other resources are bound to ranges of memory, the range of memory being bound must not overlap with those bound ranges

• memory and memoryOffset must match the memory requirements of the calling command’s image, as described in section {html_spec_relative}#resources-association
• subresource must be a valid image subresource for image (see {html_spec_relative}#resources-image-views)
• offset.x must be a multiple of the sparse image block width (VkSparseImageFormatProperties::imageGranularity.width) of the image
• extent.width must either be a multiple of the sparse image block width of the image, or else (extent.width + offset.x) must equal the width of the image subresource
• offset.y must be a multiple of the sparse image block height (VkSparseImageFormatProperties::imageGranularity.height) of the image
• extent.height must either be a multiple of the sparse image block height of the image, or else (extent.height + offset.y) must equal the height of the image subresource
• offset.z must be a multiple of the sparse image block depth (VkSparseImageFormatProperties::imageGranularity.depth) of the image
• extent.depth must either be a multiple of the sparse image block depth of the image, or else (extent.depth + offset.z) must equal the depth of the image subresource

Valid Usage (Implicit)

• subresource must be a valid VkImageSubresource structure

• If memory is not VK_NULL_HANDLE, memory must be a valid VkDeviceMemory handle
• flags must be a valid combination of VkSparseMemoryBindFlagBits values

See Also

VkDeviceMemory, VkDeviceSize, VkExtent3D, VkImageSubresource, VkOffset3D, VkSparseImageMemoryBindInfo, VkSparseMemoryBindFlags

Constructors

VkSparseImageMemoryBind

Fields

• vkSubresource :: VkImageSubresource

  subresource is the aspectMask and region of interest in the image.

• vkOffset :: VkOffset3D

  offset are the coordinates of the first texel within the image subresource to bind.

• vkExtent :: VkExtent3D

  extent is the size in texels of the region within the image subresource to bind. The extent must be a multiple of the sparse image block dimensions, except when binding sparse image blocks along the edge of an image subresource it can instead be such that any coordinate of offset + extent equals the corresponding dimensions of the image subresource.

• vkMemory :: VkDeviceMemory

  memory is the VkDeviceMemory object that the sparse image blocks of the image are bound to. If memory is VK_NULL_HANDLE, the sparse image blocks are unbound.

• vkMemoryOffset :: VkDeviceSize

  memoryOffset is an offset into VkDeviceMemory object. If memory is VK_NULL_HANDLE, this value is ignored.

• vkFlags :: VkSparseMemoryBindFlags

  flags are sparse memory binding flags.

Instances

Eq VkSparseImageMemoryBind

Methods

(==) :: VkSparseImageMemoryBind -> VkSparseImageMemoryBind -> Bool

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

Show VkSparseImageMemoryBind

Methods

showsPrec :: Int -> VkSparseImageMemoryBind -> ShowS

show :: VkSparseImageMemoryBind -> String

showList :: [VkSparseImageMemoryBind] -> ShowS

Storable VkSparseImageMemoryBind

Methods

sizeOf :: VkSparseImageMemoryBind -> Int

alignment :: VkSparseImageMemoryBind -> Int

peekElemOff :: Ptr VkSparseImageMemoryBind -> Int -> IO VkSparseImageMemoryBind

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

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

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

peek :: Ptr VkSparseImageMemoryBind -> IO VkSparseImageMemoryBind

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

data VkSparseBufferMemoryBindInfo

VkSparseBufferMemoryBindInfo - Structure specifying a sparse buffer memory bind operation

Valid Usage (Implicit)

• buffer must be a valid VkBuffer handle

• pBinds must be a valid pointer to an array of bindCount valid VkSparseMemoryBind structures
• bindCount must be greater than 0

See Also

VkBindSparseInfo, VkBuffer, VkSparseMemoryBind

Constructors

VkSparseBufferMemoryBindInfo

Fields

• vkBuffer :: VkBuffer

  buffer is the VkBuffer object to be bound.

• vkBindCount :: Word32

  bindCount is the number of VkSparseMemoryBind structures in the pBinds array.

• vkPBinds :: Ptr VkSparseMemoryBind

  pBinds is a pointer to array of VkSparseMemoryBind structures.

Instances

Eq VkSparseBufferMemoryBindInfo

Methods

(==) :: VkSparseBufferMemoryBindInfo -> VkSparseBufferMemoryBindInfo -> Bool

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

Show VkSparseBufferMemoryBindInfo

Methods

showsPrec :: Int -> VkSparseBufferMemoryBindInfo -> ShowS

show :: VkSparseBufferMemoryBindInfo -> String

showList :: [VkSparseBufferMemoryBindInfo] -> ShowS

Storable VkSparseBufferMemoryBindInfo

Methods

sizeOf :: VkSparseBufferMemoryBindInfo -> Int

alignment :: VkSparseBufferMemoryBindInfo -> Int

peekElemOff :: Ptr VkSparseBufferMemoryBindInfo -> Int -> IO VkSparseBufferMemoryBindInfo

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

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

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

peek :: Ptr VkSparseBufferMemoryBindInfo -> IO VkSparseBufferMemoryBindInfo

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

data VkSparseImageOpaqueMemoryBindInfo

VkSparseImageOpaqueMemoryBindInfo - Structure specifying sparse image opaque memory bind info

Valid Usage

• If the flags member of any element of pBinds contains VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding range defined must be within the mip tail region of the metadata aspect of image

Valid Usage (Implicit)

• image must be a valid VkImage handle

• pBinds must be a valid pointer to an array of bindCount valid VkSparseMemoryBind structures
• bindCount must be greater than 0

See Also

VkBindSparseInfo, VkImage, VkSparseMemoryBind

Constructors

VkSparseImageOpaqueMemoryBindInfo

Fields

• vkImage :: VkImage

  image is the VkImage object to be bound.

• vkBindCount :: Word32

  bindCount is the number of VkSparseMemoryBind structures in the pBinds array.

• vkPBinds :: Ptr VkSparseMemoryBind

  pBinds is a pointer to array of VkSparseMemoryBind structures.

Instances

Eq VkSparseImageOpaqueMemoryBindInfo

Methods

(==) :: VkSparseImageOpaqueMemoryBindInfo -> VkSparseImageOpaqueMemoryBindInfo -> Bool

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

Show VkSparseImageOpaqueMemoryBindInfo

Methods

showsPrec :: Int -> VkSparseImageOpaqueMemoryBindInfo -> ShowS

show :: VkSparseImageOpaqueMemoryBindInfo -> String

showList :: [VkSparseImageOpaqueMemoryBindInfo] -> ShowS

Storable VkSparseImageOpaqueMemoryBindInfo

Methods

sizeOf :: VkSparseImageOpaqueMemoryBindInfo -> Int

alignment :: VkSparseImageOpaqueMemoryBindInfo -> Int

peekElemOff :: Ptr VkSparseImageOpaqueMemoryBindInfo -> Int -> IO VkSparseImageOpaqueMemoryBindInfo

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

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

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

peek :: Ptr VkSparseImageOpaqueMemoryBindInfo -> IO VkSparseImageOpaqueMemoryBindInfo

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

data VkSparseImageMemoryBindInfo

VkSparseImageMemoryBindInfo - Structure specifying sparse image memory bind info

Valid Usage

• The subresource.mipLevel member of each element of pBinds must be less than the mipLevels specified in VkImageCreateInfo when image was created

• The subresource.arrayLayer member of each element of pBinds must be less than the arrayLayers specified in VkImageCreateInfo when image was created

Valid Usage (Implicit)

• image must be a valid VkImage handle

• pBinds must be a valid pointer to an array of bindCount valid VkSparseImageMemoryBind structures
• bindCount must be greater than 0

See Also

VkBindSparseInfo, VkImage, VkSparseImageMemoryBind

Constructors

VkSparseImageMemoryBindInfo

Fields

• vkImage :: VkImage

  image is the VkImage object to be bound

• vkBindCount :: Word32

  bindCount is the number of VkSparseImageMemoryBind structures in pBinds array

• vkPBinds :: Ptr VkSparseImageMemoryBind

  pBinds is a pointer to array of VkSparseImageMemoryBind structures

Instances

Eq VkSparseImageMemoryBindInfo

Methods

(==) :: VkSparseImageMemoryBindInfo -> VkSparseImageMemoryBindInfo -> Bool

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

Show VkSparseImageMemoryBindInfo

Methods

showsPrec :: Int -> VkSparseImageMemoryBindInfo -> ShowS

show :: VkSparseImageMemoryBindInfo -> String

showList :: [VkSparseImageMemoryBindInfo] -> ShowS

Storable VkSparseImageMemoryBindInfo

Methods

sizeOf :: VkSparseImageMemoryBindInfo -> Int

alignment :: VkSparseImageMemoryBindInfo -> Int

peekElemOff :: Ptr VkSparseImageMemoryBindInfo -> Int -> IO VkSparseImageMemoryBindInfo

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

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

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

peek :: Ptr VkSparseImageMemoryBindInfo -> IO VkSparseImageMemoryBindInfo

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

data VkBindSparseInfo

VkBindSparseInfo - Structure specifying a sparse binding operation

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_BIND_SPARSE_INFO

• pNext must be NULL or a pointer to a valid instance of VkDeviceGroupBindSparseInfo
• If waitSemaphoreCount is not 0, pWaitSemaphores must be a valid pointer to an array of waitSemaphoreCount valid VkSemaphore handles
• If bufferBindCount is not 0, pBufferBinds must be a valid pointer to an array of bufferBindCount valid VkSparseBufferMemoryBindInfo structures
• If imageOpaqueBindCount is not 0, pImageOpaqueBinds must be a valid pointer to an array of imageOpaqueBindCount valid VkSparseImageOpaqueMemoryBindInfo structures
• If imageBindCount is not 0, pImageBinds must be a valid pointer to an array of imageBindCount valid VkSparseImageMemoryBindInfo structures
• If signalSemaphoreCount is not 0, pSignalSemaphores must be a valid pointer to an array of signalSemaphoreCount valid VkSemaphore handles
• Both of the elements of pSignalSemaphores, and the elements of pWaitSemaphores that are valid handles must have been created, allocated, or retrieved from the same VkDevice

See Also

VkSemaphore, VkSparseBufferMemoryBindInfo, VkSparseImageMemoryBindInfo, VkSparseImageOpaqueMemoryBindInfo, VkStructureType, vkQueueBindSparse

Constructors

VkBindSparseInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkWaitSemaphoreCount :: Word32

  waitSemaphoreCount is the number of semaphores upon which to wait before executing the sparse binding operations for the batch.

• vkPWaitSemaphores :: Ptr VkSemaphore

  pWaitSemaphores is a pointer to an array of semaphores upon which to wait on before the sparse binding operations for this batch begin execution. If semaphores to wait on are provided, they define a semaphore wait operation.

• vkBufferBindCount :: Word32

  bufferBindCount is the number of sparse buffer bindings to perform in the batch.

• vkPBufferBinds :: Ptr VkSparseBufferMemoryBindInfo

  pBufferBinds is a pointer to an array of VkSparseBufferMemoryBindInfo structures.

• vkImageOpaqueBindCount :: Word32

  imageOpaqueBindCount is the number of opaque sparse image bindings to perform.

• vkPImageOpaqueBinds :: Ptr VkSparseImageOpaqueMemoryBindInfo

  pImageOpaqueBinds is a pointer to an array of VkSparseImageOpaqueMemoryBindInfo structures, indicating opaque sparse image bindings to perform.

• vkImageBindCount :: Word32

  imageBindCount is the number of sparse image bindings to perform.

• vkPImageBinds :: Ptr VkSparseImageMemoryBindInfo

  pImageBinds is a pointer to an array of VkSparseImageMemoryBindInfo structures, indicating sparse image bindings to perform.

• vkSignalSemaphoreCount :: Word32

  signalSemaphoreCount is the number of semaphores to be signaled once the sparse binding operations specified by the structure have completed execution.

• vkPSignalSemaphores :: Ptr VkSemaphore

  pSignalSemaphores is a pointer to an array of semaphores which will be signaled when the sparse binding operations for this batch have completed execution. If semaphores to be signaled are provided, they define a semaphore signal operation.

Instances

Eq VkBindSparseInfo

Methods

(==) :: VkBindSparseInfo -> VkBindSparseInfo -> Bool

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

Show VkBindSparseInfo

Methods

showsPrec :: Int -> VkBindSparseInfo -> ShowS

show :: VkBindSparseInfo -> String

showList :: [VkBindSparseInfo] -> ShowS

Storable VkBindSparseInfo

Methods

sizeOf :: VkBindSparseInfo -> Int

alignment :: VkBindSparseInfo -> Int

peekElemOff :: Ptr VkBindSparseInfo -> Int -> IO VkBindSparseInfo

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

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

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

peek :: Ptr VkBindSparseInfo -> IO VkBindSparseInfo

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

type VkImageAspectFlags = VkImageAspectFlagBits

VkImageAspectFlags - Bitmask of VkImageAspectFlagBits

Description

VkImageAspectFlags is a bitmask type for setting a mask of zero or more VkImageAspectFlagBits.

See Also

VkClearAttachment, VkImageAspectFlagBits, VkImageSubresource, VkImageSubresourceLayers, VkImageSubresourceRange, VkInputAttachmentAspectReference, VkSparseImageFormatProperties

type VkSparseMemoryBindFlags = VkSparseMemoryBindFlagBits

VkSparseMemoryBindFlags - Bitmask of VkSparseMemoryBindFlagBits

Description

VkSparseMemoryBindFlags is a bitmask type for setting a mask of zero or more VkSparseMemoryBindFlagBits.

See Also

VkSparseImageMemoryBind, VkSparseMemoryBind, VkSparseMemoryBindFlagBits

type VkSparseImageFormatFlags = VkSparseImageFormatFlagBits

VkSparseImageFormatFlags - Bitmask of VkSparseImageFormatFlagBits

Description

VkSparseImageFormatFlags is a bitmask type for setting a mask of zero or more VkSparseImageFormatFlagBits.

See Also

VkSparseImageFormatFlagBits, VkSparseImageFormatProperties