Vulkan.Core10.SparseResourceMemoryManagement

Documentation

getImageSparseMemoryRequirements

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the image.

-> Image

image is the Image object to get the memory requirements for.

-> io ("sparseMemoryRequirements" ::: Vector SparseImageMemoryRequirements)

vkGetImageSparseMemoryRequirements - Query the memory requirements for a sparse image

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 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 MemoryRequirements::size than would be obtained by adding together memory sizes for all SparseImageMemoryRequirements returned by getImageSparseMemoryRequirements. This may occur when the implementation requires unused padding in the address range describing the resource.

Valid Usage (Implicit)

• device must be a valid Device handle

• image must be a valid Image 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 SparseImageMemoryRequirements structures
• image must have been created, allocated, or retrieved from device

See Also

Device, Image, SparseImageMemoryRequirements

getPhysicalDeviceSparseImageFormatProperties

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

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

-> Format

format is the image format.

-> ImageType

type is the dimensionality of image.

-> ("samples" ::: SampleCountFlagBits)

samples is the number of samples per texel as defined in SampleCountFlagBits.

-> ImageUsageFlags

usage is a bitmask describing the intended usage of the image.

-> ImageTiling

tiling is the tiling arrangement of the texel blocks in memory.

-> io ("properties" ::: Vector SparseImageFormatProperties)

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

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 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 SparseImageFormatProperties data.

Depth/stencil images with depth and stencil data interleaved into a single plane will return a single SparseImageFormatProperties structure with the aspectMask set to IMAGE_ASPECT_DEPTH_BIT | IMAGE_ASPECT_STENCIL_BIT.

Valid Usage

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

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• format must be a valid Format value
• type must be a valid ImageType value
• samples must be a valid SampleCountFlagBits value
• usage must be a valid combination of ImageUsageFlagBits values
• usage must not be 0
• tiling must be a valid ImageTiling 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 SparseImageFormatProperties structures

See Also

Format, ImageTiling, ImageType, ImageUsageFlags, PhysicalDevice, SampleCountFlagBits, SparseImageFormatProperties

queueBindSparse

Arguments

:: forall io. MonadIO io

=> Queue

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

-> ("bindInfo" ::: Vector (SomeStruct BindSparseInfo))

pBindInfo is a pointer to an array of BindSparseInfo structures, each specifying a sparse binding submission batch.

-> Fence

fence is an optional handle to a fence to be signaled. If fence is not NULL_HANDLE, it defines a fence signal operation.

-> io ()

vkQueueBindSparse - Bind device memory to a sparse resource object

Description

queueBindSparse is a queue submission command, with each batch defined by an element of pBindInfo as a BindSparseInfo 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 queueBindSparse 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 NULL_HANDLE, fence must be unsignaled

• If fence is not 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 wait operation referring to a binary semaphore defined by any element of the pWaitSemaphores member of any element of pBindInfo executes on queue, there must be no other queues waiting on the same semaphore
• All elements of the pWaitSemaphores member of all elements of pBindInfo member referring to a binary semaphore must be semaphores that are signaled, or have semaphore signal operations previously submitted for execution
• All elements of the pWaitSemaphores member of all elements of pBindInfo created with a SemaphoreType of SEMAPHORE_TYPE_BINARY must reference a semaphore signal operation that has been submitted for execution and any semaphore signal operations on which it depends (if any) must have also been submitted for execution

Valid Usage (Implicit)

• queue must be a valid Queue handle

• If bindInfoCount is not 0, pBindInfo must be a valid pointer to an array of bindInfoCount valid BindSparseInfo structures
• If fence is not NULL_HANDLE, fence must be a valid Fence handle
• The queue must support sparse binding operations
• Both of fence, and queue that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to queue 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

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

BindSparseInfo, Fence, Queue

data SparseImageFormatProperties

VkSparseImageFormatProperties - Structure specifying sparse image format properties

See Also

Extent3D, ImageAspectFlags, SparseImageFormatFlags, SparseImageFormatProperties2, SparseImageMemoryRequirements, getPhysicalDeviceSparseImageFormatProperties

Constructors

SparseImageFormatProperties

Fields

• aspectMask :: ImageAspectFlags

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

• imageGranularity :: Extent3D

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

• flags :: SparseImageFormatFlags

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

Instances

Show SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseImageFormatProperties -> ShowS

show :: SparseImageFormatProperties -> String

showList :: [SparseImageFormatProperties] -> ShowS

Generic SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseImageFormatProperties :: Type -> Type

Methods

from :: SparseImageFormatProperties -> Rep SparseImageFormatProperties x

to :: Rep SparseImageFormatProperties x -> SparseImageFormatProperties

FromCStruct SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseImageFormatProperties -> IO SparseImageFormatProperties

ToCStruct SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseImageFormatProperties -> SparseImageFormatProperties -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseImageFormatProperties -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseImageFormatProperties

type Rep SparseImageFormatProperties

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseImageFormatProperties = D1 ('MetaData "SparseImageFormatProperties" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseImageFormatProperties" 'PrefixI 'True) (S1 ('MetaSel ('Just "aspectMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageAspectFlags) :*: (S1 ('MetaSel ('Just "imageGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Extent3D) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SparseImageFormatFlags))))

data SparseImageMemoryRequirements

VkSparseImageMemoryRequirements - Structure specifying sparse image memory requirements

See Also

DeviceSize, SparseImageFormatProperties, SparseImageMemoryRequirements2, getImageSparseMemoryRequirements

Constructors

SparseImageMemoryRequirements

Fields

• formatProperties :: SparseImageFormatProperties
• imageMipTailFirstLod :: Word32

  imageMipTailFirstLod is the first mip level at which image subresources are included in the mip tail region.

• imageMipTailSize :: DeviceSize

  imageMipTailSize is the memory size (in bytes) of the mip tail region. If formatProperties.flags contains 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 :: DeviceSize

  imageMipTailOffset is the opaque memory offset used with SparseImageOpaqueMemoryBindInfo to bind the mip tail region(s).

• imageMipTailStride :: DeviceSize

  imageMipTailStride is the offset stride between each array-layer’s mip tail, if formatProperties.flags does not contain SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT (otherwise the value is undefined).

Instances

Show SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseImageMemoryRequirements -> ShowS

show :: SparseImageMemoryRequirements -> String

showList :: [SparseImageMemoryRequirements] -> ShowS

Generic SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseImageMemoryRequirements :: Type -> Type

Methods

from :: SparseImageMemoryRequirements -> Rep SparseImageMemoryRequirements x

to :: Rep SparseImageMemoryRequirements x -> SparseImageMemoryRequirements

FromCStruct SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseImageMemoryRequirements -> IO SparseImageMemoryRequirements

ToCStruct SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseImageMemoryRequirements -> SparseImageMemoryRequirements -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseImageMemoryRequirements -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseImageMemoryRequirements

type Rep SparseImageMemoryRequirements

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseImageMemoryRequirements = D1 ('MetaData "SparseImageMemoryRequirements" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseImageMemoryRequirements" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formatProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SparseImageFormatProperties) :*: S1 ('MetaSel ('Just "imageMipTailFirstLod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "imageMipTailSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: (S1 ('MetaSel ('Just "imageMipTailOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "imageMipTailStride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)))))

data ImageSubresource

VkImageSubresource - Structure specifying an image subresource

Valid Usage (Implicit)

See Also

ImageAspectFlags, SparseImageMemoryBind, getImageSubresourceLayout

Constructors

ImageSubresource

Fields

• aspectMask :: ImageAspectFlags

  aspectMask is a ImageAspectFlags selecting the image aspect.

  aspectMask must be a valid combination of ImageAspectFlagBits values

  aspectMask must not be 0

• mipLevel :: Word32

  mipLevel selects the mipmap level.

• arrayLayer :: Word32

  arrayLayer selects the array layer.

Instances

Eq ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

(==) :: ImageSubresource -> ImageSubresource -> Bool

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

Show ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> ImageSubresource -> ShowS

show :: ImageSubresource -> String

showList :: [ImageSubresource] -> ShowS

Generic ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep ImageSubresource :: Type -> Type

Methods

from :: ImageSubresource -> Rep ImageSubresource x

to :: Rep ImageSubresource x -> ImageSubresource

Storable ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

sizeOf :: ImageSubresource -> Int

alignment :: ImageSubresource -> Int

peekElemOff :: Ptr ImageSubresource -> Int -> IO ImageSubresource

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

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

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

peek :: Ptr ImageSubresource -> IO ImageSubresource

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

FromCStruct ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr ImageSubresource -> IO ImageSubresource

ToCStruct ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr ImageSubresource -> ImageSubresource -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ImageSubresource -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: ImageSubresource

type Rep ImageSubresource

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep ImageSubresource = D1 ('MetaData "ImageSubresource" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "ImageSubresource" 'PrefixI 'True) (S1 ('MetaSel ('Just "aspectMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageAspectFlags) :*: (S1 ('MetaSel ('Just "mipLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "arrayLayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

data SparseMemoryBind

VkSparseMemoryBind - Structure specifying a sparse memory bind operation

Description

The binding range [resourceOffset, resourceOffset + size) has different constraints based on flags. If flags contains 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 SparseImageMemoryRequirements 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 SparseImageMemoryRequirements::formatProperties.flags contains SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT.

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

Valid Usage

• If memory is not NULL_HANDLE, memory and memoryOffset must match the memory requirements of the resource, as described in section https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#resources-association

• If memory is not NULL_HANDLE, memory must not have been created with a memory type that reports 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
• If memory was created with ExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in ExternalMemoryBufferCreateInfo::handleTypes or ExternalMemoryImageCreateInfo::handleTypes when the resource was created
• If memory was created by a memory import operation, the external handle type of the imported memory must also have been set in ExternalMemoryBufferCreateInfo::handleTypes or ExternalMemoryImageCreateInfo::handleTypes when the resource was created

Valid Usage (Implicit)

• If memory is not NULL_HANDLE, memory must be a valid DeviceMemory handle

• flags must be a valid combination of SparseMemoryBindFlagBits values

See Also

DeviceMemory, DeviceSize, SparseBufferMemoryBindInfo, SparseImageOpaqueMemoryBindInfo, SparseMemoryBindFlags

Constructors

SparseMemoryBind

Fields

• resourceOffset :: DeviceSize

  resourceOffset is the offset into the resource.

• size :: DeviceSize

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

• memory :: DeviceMemory

  memory is the DeviceMemory object that the range of the resource is bound to. If memory is NULL_HANDLE, the range is unbound.

• memoryOffset :: DeviceSize

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

• flags :: SparseMemoryBindFlags

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

Instances

Eq SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

(==) :: SparseMemoryBind -> SparseMemoryBind -> Bool

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

Show SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseMemoryBind -> ShowS

show :: SparseMemoryBind -> String

showList :: [SparseMemoryBind] -> ShowS

Generic SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseMemoryBind :: Type -> Type

Methods

from :: SparseMemoryBind -> Rep SparseMemoryBind x

to :: Rep SparseMemoryBind x -> SparseMemoryBind

Storable SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

sizeOf :: SparseMemoryBind -> Int

alignment :: SparseMemoryBind -> Int

peekElemOff :: Ptr SparseMemoryBind -> Int -> IO SparseMemoryBind

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

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

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

peek :: Ptr SparseMemoryBind -> IO SparseMemoryBind

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

FromCStruct SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseMemoryBind -> IO SparseMemoryBind

ToCStruct SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseMemoryBind -> SparseMemoryBind -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseMemoryBind -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseMemoryBind

type Rep SparseMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseMemoryBind = D1 ('MetaData "SparseMemoryBind" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseMemoryBind" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceMemory) :*: (S1 ('MetaSel ('Just "memoryOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SparseMemoryBindFlags)))))

data SparseImageMemoryBind

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 https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#resources-association
• subresource must be a valid image subresource for image (see https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#resources-image-views)
• offset.x must be a multiple of the sparse image block width (SparseImageFormatProperties::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 (SparseImageFormatProperties::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 (SparseImageFormatProperties::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
• If memory was created with ExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in ExternalMemoryImageCreateInfo::handleTypes when the image was created
• If memory was created by a memory import operation, the external handle type of the imported memory must also have been set in ExternalMemoryImageCreateInfo::handleTypes when image was created

Valid Usage (Implicit)

• subresource must be a valid ImageSubresource structure

• If memory is not NULL_HANDLE, memory must be a valid DeviceMemory handle
• flags must be a valid combination of SparseMemoryBindFlagBits values

See Also

DeviceMemory, DeviceSize, Extent3D, ImageSubresource, Offset3D, SparseImageMemoryBindInfo, SparseMemoryBindFlags

Constructors

SparseImageMemoryBind

Fields

• subresource :: ImageSubresource

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

• offset :: Offset3D

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

• extent :: Extent3D

  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.

• memory :: DeviceMemory

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

• memoryOffset :: DeviceSize

  memoryOffset is an offset into DeviceMemory object. If memory is NULL_HANDLE, this value is ignored.

• flags :: SparseMemoryBindFlags

  flags are sparse memory binding flags.

Instances

Show SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseImageMemoryBind -> ShowS

show :: SparseImageMemoryBind -> String

showList :: [SparseImageMemoryBind] -> ShowS

Generic SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseImageMemoryBind :: Type -> Type

Methods

from :: SparseImageMemoryBind -> Rep SparseImageMemoryBind x

to :: Rep SparseImageMemoryBind x -> SparseImageMemoryBind

FromCStruct SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseImageMemoryBind -> IO SparseImageMemoryBind

ToCStruct SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseImageMemoryBind -> SparseImageMemoryBind -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseImageMemoryBind -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseImageMemoryBind

type Rep SparseImageMemoryBind

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseImageMemoryBind = D1 ('MetaData "SparseImageMemoryBind" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseImageMemoryBind" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subresource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageSubresource) :*: (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset3D) :*: S1 ('MetaSel ('Just "extent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Extent3D))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceMemory) :*: (S1 ('MetaSel ('Just "memoryOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SparseMemoryBindFlags)))))

data SparseBufferMemoryBindInfo

VkSparseBufferMemoryBindInfo - Structure specifying a sparse buffer memory bind operation

Valid Usage (Implicit)

See Also

BindSparseInfo, Buffer, SparseMemoryBind

Constructors

SparseBufferMemoryBindInfo

Fields

• buffer :: Buffer

  buffer is the Buffer object to be bound.

  buffer must be a valid Buffer handle

• binds :: Vector SparseMemoryBind

  pBinds is a pointer to array of SparseMemoryBind structures.

  pBinds must be a valid pointer to an array of bindCount valid SparseMemoryBind structures

Instances

Show SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseBufferMemoryBindInfo -> ShowS

show :: SparseBufferMemoryBindInfo -> String

showList :: [SparseBufferMemoryBindInfo] -> ShowS

Generic SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseBufferMemoryBindInfo :: Type -> Type

Methods

from :: SparseBufferMemoryBindInfo -> Rep SparseBufferMemoryBindInfo x

to :: Rep SparseBufferMemoryBindInfo x -> SparseBufferMemoryBindInfo

FromCStruct SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseBufferMemoryBindInfo -> IO SparseBufferMemoryBindInfo

ToCStruct SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseBufferMemoryBindInfo -> SparseBufferMemoryBindInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseBufferMemoryBindInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseBufferMemoryBindInfo

type Rep SparseBufferMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseBufferMemoryBindInfo = D1 ('MetaData "SparseBufferMemoryBindInfo" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseBufferMemoryBindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Buffer) :*: S1 ('MetaSel ('Just "binds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseMemoryBind))))

data SparseImageOpaqueMemoryBindInfo

VkSparseImageOpaqueMemoryBindInfo - Structure specifying sparse image opaque memory bind info

Valid Usage

• If the flags member of any element of pBinds contains 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 Image handle

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

See Also

BindSparseInfo, Image, SparseMemoryBind

Constructors

SparseImageOpaqueMemoryBindInfo

Fields

• image :: Image

  image is the Image object to be bound.

• binds :: Vector SparseMemoryBind

  pBinds is a pointer to an array of SparseMemoryBind structures.

Instances

Show SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseImageOpaqueMemoryBindInfo -> ShowS

show :: SparseImageOpaqueMemoryBindInfo -> String

showList :: [SparseImageOpaqueMemoryBindInfo] -> ShowS

Generic SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseImageOpaqueMemoryBindInfo :: Type -> Type

Methods

from :: SparseImageOpaqueMemoryBindInfo -> Rep SparseImageOpaqueMemoryBindInfo x

to :: Rep SparseImageOpaqueMemoryBindInfo x -> SparseImageOpaqueMemoryBindInfo

FromCStruct SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseImageOpaqueMemoryBindInfo -> IO SparseImageOpaqueMemoryBindInfo

ToCStruct SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseImageOpaqueMemoryBindInfo -> SparseImageOpaqueMemoryBindInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseImageOpaqueMemoryBindInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseImageOpaqueMemoryBindInfo

type Rep SparseImageOpaqueMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseImageOpaqueMemoryBindInfo = D1 ('MetaData "SparseImageOpaqueMemoryBindInfo" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseImageOpaqueMemoryBindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Image) :*: S1 ('MetaSel ('Just "binds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseMemoryBind))))

data SparseImageMemoryBindInfo

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 ImageCreateInfo when image was created

• The subresource.arrayLayer member of each element of pBinds must be less than the arrayLayers specified in ImageCreateInfo when image was created
• image must have been created with IMAGE_CREATE_SPARSE_RESIDENCY_BIT set

Valid Usage (Implicit)

• image must be a valid Image handle

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

See Also

BindSparseInfo, Image, SparseImageMemoryBind

Constructors

SparseImageMemoryBindInfo

Fields

• image :: Image

  image is the Image object to be bound

• binds :: Vector SparseImageMemoryBind

  pBinds is a pointer to an array of SparseImageMemoryBind structures

Instances

Show SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> SparseImageMemoryBindInfo -> ShowS

show :: SparseImageMemoryBindInfo -> String

showList :: [SparseImageMemoryBindInfo] -> ShowS

Generic SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep SparseImageMemoryBindInfo :: Type -> Type

Methods

from :: SparseImageMemoryBindInfo -> Rep SparseImageMemoryBindInfo x

to :: Rep SparseImageMemoryBindInfo x -> SparseImageMemoryBindInfo

FromCStruct SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

peekCStruct :: Ptr SparseImageMemoryBindInfo -> IO SparseImageMemoryBindInfo

ToCStruct SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

pokeCStruct :: Ptr SparseImageMemoryBindInfo -> SparseImageMemoryBindInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SparseImageMemoryBindInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: SparseImageMemoryBindInfo

type Rep SparseImageMemoryBindInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep SparseImageMemoryBindInfo = D1 ('MetaData "SparseImageMemoryBindInfo" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "SparseImageMemoryBindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Image) :*: S1 ('MetaSel ('Just "binds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseImageMemoryBind))))

data BindSparseInfo (es :: [Type])

VkBindSparseInfo - Structure specifying a sparse binding operation

Valid Usage

• If any element of pWaitSemaphores or pSignalSemaphores was created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE then the pNext chain must include a TimelineSemaphoreSubmitInfo structure

• If the pNext chain of this structure includes a TimelineSemaphoreSubmitInfo structure and any element of pWaitSemaphores was created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE then its waitSemaphoreValueCount member must equal waitSemaphoreCount
• If the pNext chain of this structure includes a TimelineSemaphoreSubmitInfo structure and any element of pSignalSemaphores was created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE then its signalSemaphoreValueCount member must equal signalSemaphoreCount
• For each element of pSignalSemaphores created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE the corresponding element of TimelineSemaphoreSubmitInfo::pSignalSemaphoreValues must have a value greater than the current value of the semaphore when the semaphore signal operation is executed
• For each element of pWaitSemaphores created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE the corresponding element of TimelineSemaphoreSubmitInfo::pWaitSemaphoreValues must have a value which does not differ from the current value of the semaphore or from the value of any outstanding semaphore wait or signal operation on that semaphore by more than maxTimelineSemaphoreValueDifference
• For each element of pSignalSemaphores created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE the corresponding element of TimelineSemaphoreSubmitInfo::pSignalSemaphoreValues must have a value which does not differ from the current value of the semaphore or from the value of any outstanding semaphore wait or signal operation on that semaphore by more than maxTimelineSemaphoreValueDifference

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_SPARSE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of DeviceGroupBindSparseInfo or TimelineSemaphoreSubmitInfo
• The sType value of each struct in the pNext chain must be unique
• If waitSemaphoreCount is not 0, pWaitSemaphores must be a valid pointer to an array of waitSemaphoreCount valid Semaphore handles
• If bufferBindCount is not 0, pBufferBinds must be a valid pointer to an array of bufferBindCount valid SparseBufferMemoryBindInfo structures
• If imageOpaqueBindCount is not 0, pImageOpaqueBinds must be a valid pointer to an array of imageOpaqueBindCount valid SparseImageOpaqueMemoryBindInfo structures
• If imageBindCount is not 0, pImageBinds must be a valid pointer to an array of imageBindCount valid SparseImageMemoryBindInfo structures
• If signalSemaphoreCount is not 0, pSignalSemaphores must be a valid pointer to an array of signalSemaphoreCount valid Semaphore handles
• Both of the elements of pSignalSemaphores, and the elements of pWaitSemaphores that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

Semaphore, SparseBufferMemoryBindInfo, SparseImageMemoryBindInfo, SparseImageOpaqueMemoryBindInfo, StructureType, queueBindSparse

Constructors

BindSparseInfo

Fields

• next :: Chain es

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

• waitSemaphores :: Vector Semaphore

  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.

• bufferBinds :: Vector SparseBufferMemoryBindInfo

  pBufferBinds is a pointer to an array of SparseBufferMemoryBindInfo structures.

• imageOpaqueBinds :: Vector SparseImageOpaqueMemoryBindInfo

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

• imageBinds :: Vector SparseImageMemoryBindInfo

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

• signalSemaphores :: Vector Semaphore

  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

Extensible BindSparseInfo

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (BindSparseInfo es)

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

showsPrec :: Int -> BindSparseInfo es -> ShowS

show :: BindSparseInfo es -> String

showList :: [BindSparseInfo es] -> ShowS

Generic (BindSparseInfo es)

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Associated Types

type Rep (BindSparseInfo es) :: Type -> Type

Methods

from :: BindSparseInfo es -> Rep (BindSparseInfo es) x

to :: Rep (BindSparseInfo es) x -> BindSparseInfo es

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

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

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

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Core10.SparseResourceMemoryManagement

Methods

zero :: BindSparseInfo es

type Rep (BindSparseInfo es)

Defined in Vulkan.Core10.SparseResourceMemoryManagement

type Rep (BindSparseInfo es) = D1 ('MetaData "BindSparseInfo" "Vulkan.Core10.SparseResourceMemoryManagement" "vulkan-3.6.9-inplace" 'False) (C1 ('MetaCons "BindSparseInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: (S1 ('MetaSel ('Just "waitSemaphores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Semaphore)) :*: S1 ('MetaSel ('Just "bufferBinds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseBufferMemoryBindInfo)))) :*: (S1 ('MetaSel ('Just "imageOpaqueBinds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseImageOpaqueMemoryBindInfo)) :*: (S1 ('MetaSel ('Just "imageBinds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SparseImageMemoryBindInfo)) :*: S1 ('MetaSel ('Just "signalSemaphores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Semaphore))))))

newtype ImageAspectFlagBits

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

See Also

BindImagePlaneMemoryInfo, ImageAspectFlags, ImagePlaneMemoryRequirementsInfo

Constructors

ImageAspectFlagBits Flags

Bundled Patterns

pattern IMAGE_ASPECT_COLOR_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_COLOR_BIT specifies the color aspect.

pattern IMAGE_ASPECT_DEPTH_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_DEPTH_BIT specifies the depth aspect.

pattern IMAGE_ASPECT_STENCIL_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_STENCIL_BIT specifies the stencil aspect.

pattern IMAGE_ASPECT_METADATA_BIT :: ImageAspectFlagBits

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

pattern IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT :: ImageAspectFlagBits

IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT specifies memory plane 3.

pattern IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT :: ImageAspectFlagBits

IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT specifies memory plane 2.

pattern IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT :: ImageAspectFlagBits

IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT specifies memory plane 1.

pattern IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT :: ImageAspectFlagBits

IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT specifies memory plane 0.

pattern IMAGE_ASPECT_PLANE_2_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_PLANE_2_BIT specifies plane 2 of a multi-planar image format.

pattern IMAGE_ASPECT_PLANE_1_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_PLANE_1_BIT specifies plane 1 of a multi-planar image format.

pattern IMAGE_ASPECT_PLANE_0_BIT :: ImageAspectFlagBits

IMAGE_ASPECT_PLANE_0_BIT specifies plane 0 of a multi-planar image format.

Instances

Eq ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

(==) :: ImageAspectFlagBits -> ImageAspectFlagBits -> Bool

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

Ord ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

compare :: ImageAspectFlagBits -> ImageAspectFlagBits -> Ordering

(<) :: ImageAspectFlagBits -> ImageAspectFlagBits -> Bool

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

(>) :: ImageAspectFlagBits -> ImageAspectFlagBits -> Bool

(>=) :: ImageAspectFlagBits -> ImageAspectFlagBits -> Bool

max :: ImageAspectFlagBits -> ImageAspectFlagBits -> ImageAspectFlagBits

min :: ImageAspectFlagBits -> ImageAspectFlagBits -> ImageAspectFlagBits

Read ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

readsPrec :: Int -> ReadS ImageAspectFlagBits

readList :: ReadS [ImageAspectFlagBits]

readPrec :: ReadPrec ImageAspectFlagBits

readListPrec :: ReadPrec [ImageAspectFlagBits]

Show ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

showsPrec :: Int -> ImageAspectFlagBits -> ShowS

show :: ImageAspectFlagBits -> String

showList :: [ImageAspectFlagBits] -> ShowS

Storable ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

sizeOf :: ImageAspectFlagBits -> Int

alignment :: ImageAspectFlagBits -> Int

peekElemOff :: Ptr ImageAspectFlagBits -> Int -> IO ImageAspectFlagBits

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

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

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

peek :: Ptr ImageAspectFlagBits -> IO ImageAspectFlagBits

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

Bits ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

(.&.) :: ImageAspectFlagBits -> ImageAspectFlagBits -> ImageAspectFlagBits

(.|.) :: ImageAspectFlagBits -> ImageAspectFlagBits -> ImageAspectFlagBits

xor :: ImageAspectFlagBits -> ImageAspectFlagBits -> ImageAspectFlagBits

complement :: ImageAspectFlagBits -> ImageAspectFlagBits

shift :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

rotate :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

zeroBits :: ImageAspectFlagBits

bit :: Int -> ImageAspectFlagBits

setBit :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

clearBit :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

complementBit :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

testBit :: ImageAspectFlagBits -> Int -> Bool

bitSizeMaybe :: ImageAspectFlagBits -> Maybe Int

bitSize :: ImageAspectFlagBits -> Int

isSigned :: ImageAspectFlagBits -> Bool

shiftL :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

unsafeShiftL :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

shiftR :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

unsafeShiftR :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

rotateL :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

rotateR :: ImageAspectFlagBits -> Int -> ImageAspectFlagBits

popCount :: ImageAspectFlagBits -> Int

Zero ImageAspectFlagBits

Defined in Vulkan.Core10.Enums.ImageAspectFlagBits

Methods

zero :: ImageAspectFlagBits

type ImageAspectFlags = ImageAspectFlagBits

newtype SparseImageFormatFlagBits

VkSparseImageFormatFlagBits - Bitmask specifying additional information about a sparse image resource

See Also

SparseImageFormatFlags

Constructors

SparseImageFormatFlagBits Flags

Bundled Patterns

pattern SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT :: SparseImageFormatFlagBits

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

pattern SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT :: SparseImageFormatFlagBits

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 SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT :: SparseImageFormatFlagBits

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.

Instances

Eq SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

(==) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> Bool

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

Ord SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

compare :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> Ordering

(<) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> Bool

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

(>) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> Bool

(>=) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> Bool

max :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> SparseImageFormatFlagBits

min :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> SparseImageFormatFlagBits

Read SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

readsPrec :: Int -> ReadS SparseImageFormatFlagBits

readList :: ReadS [SparseImageFormatFlagBits]

readPrec :: ReadPrec SparseImageFormatFlagBits

readListPrec :: ReadPrec [SparseImageFormatFlagBits]

Show SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

showsPrec :: Int -> SparseImageFormatFlagBits -> ShowS

show :: SparseImageFormatFlagBits -> String

showList :: [SparseImageFormatFlagBits] -> ShowS

Storable SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

sizeOf :: SparseImageFormatFlagBits -> Int

alignment :: SparseImageFormatFlagBits -> Int

peekElemOff :: Ptr SparseImageFormatFlagBits -> Int -> IO SparseImageFormatFlagBits

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

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

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

peek :: Ptr SparseImageFormatFlagBits -> IO SparseImageFormatFlagBits

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

Bits SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

(.&.) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> SparseImageFormatFlagBits

(.|.) :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> SparseImageFormatFlagBits

xor :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits -> SparseImageFormatFlagBits

complement :: SparseImageFormatFlagBits -> SparseImageFormatFlagBits

shift :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

rotate :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

zeroBits :: SparseImageFormatFlagBits

bit :: Int -> SparseImageFormatFlagBits

setBit :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

clearBit :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

complementBit :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

testBit :: SparseImageFormatFlagBits -> Int -> Bool

bitSizeMaybe :: SparseImageFormatFlagBits -> Maybe Int

bitSize :: SparseImageFormatFlagBits -> Int

isSigned :: SparseImageFormatFlagBits -> Bool

shiftL :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

unsafeShiftL :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

shiftR :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

unsafeShiftR :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

rotateL :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

rotateR :: SparseImageFormatFlagBits -> Int -> SparseImageFormatFlagBits

popCount :: SparseImageFormatFlagBits -> Int

Zero SparseImageFormatFlagBits

Defined in Vulkan.Core10.Enums.SparseImageFormatFlagBits

Methods

zero :: SparseImageFormatFlagBits

type SparseImageFormatFlags = SparseImageFormatFlagBits

newtype SparseMemoryBindFlagBits

VkSparseMemoryBindFlagBits - Bitmask specifying usage of a sparse memory binding operation

See Also

SparseMemoryBindFlags

Constructors

SparseMemoryBindFlagBits Flags

Bundled Patterns

pattern SPARSE_MEMORY_BIND_METADATA_BIT :: SparseMemoryBindFlagBits

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

Instances

Eq SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

(==) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> Bool

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

Ord SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

compare :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> Ordering

(<) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> Bool

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

(>) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> Bool

(>=) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> Bool

max :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

min :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

Read SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

readsPrec :: Int -> ReadS SparseMemoryBindFlagBits

readList :: ReadS [SparseMemoryBindFlagBits]

readPrec :: ReadPrec SparseMemoryBindFlagBits

readListPrec :: ReadPrec [SparseMemoryBindFlagBits]

Show SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

showsPrec :: Int -> SparseMemoryBindFlagBits -> ShowS

show :: SparseMemoryBindFlagBits -> String

showList :: [SparseMemoryBindFlagBits] -> ShowS

Storable SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

sizeOf :: SparseMemoryBindFlagBits -> Int

alignment :: SparseMemoryBindFlagBits -> Int

peekElemOff :: Ptr SparseMemoryBindFlagBits -> Int -> IO SparseMemoryBindFlagBits

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

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

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

peek :: Ptr SparseMemoryBindFlagBits -> IO SparseMemoryBindFlagBits

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

Bits SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

(.&.) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

(.|.) :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

xor :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

complement :: SparseMemoryBindFlagBits -> SparseMemoryBindFlagBits

shift :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

rotate :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

zeroBits :: SparseMemoryBindFlagBits

bit :: Int -> SparseMemoryBindFlagBits

setBit :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

clearBit :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

complementBit :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

testBit :: SparseMemoryBindFlagBits -> Int -> Bool

bitSizeMaybe :: SparseMemoryBindFlagBits -> Maybe Int

bitSize :: SparseMemoryBindFlagBits -> Int

isSigned :: SparseMemoryBindFlagBits -> Bool

shiftL :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

unsafeShiftL :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

shiftR :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

unsafeShiftR :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

rotateL :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

rotateR :: SparseMemoryBindFlagBits -> Int -> SparseMemoryBindFlagBits

popCount :: SparseMemoryBindFlagBits -> Int

Zero SparseMemoryBindFlagBits

Defined in Vulkan.Core10.Enums.SparseMemoryBindFlagBits

Methods

zero :: SparseMemoryBindFlagBits

type SparseMemoryBindFlags = SparseMemoryBindFlagBits