Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_NV_extended_sparse_address_space

Description

Name

VK_NV_extended_sparse_address_space - device extension

VK_NV_extended_sparse_address_space

Name String: VK_NV_extended_sparse_address_space

Extension Type

Device extension

Registered Extension Number

493

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies; Contact

Russell Chou @russellcnv%0A*Here describe the issue or question you have about the VK_NV_extended_sparse_address_space extension*

Other Extension Metadata

Last Modified Date: 2023-10-03

Contributors

Russell Chou, NVIDIA
Christoph Kubisch, NVIDIA
Eric Werness, NVIDIA
Jeff Bolz, NVIDIA

Description

Implementations may be able to support an extended address space for sparse memory resources, but only for a certain set of usages.

This extension adds a query for the extended limit, and the supported usages that are allowed for that limit. This limit is an increase to PhysicalDeviceLimits::sparseAddressSpaceSize when the Image or Buffer uses only usages that are supported.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceExtendedSparseAddressSpaceFeaturesNV

Extending PhysicalDeviceProperties2:
- PhysicalDeviceExtendedSparseAddressSpacePropertiesNV

New Enum Constants

NV_EXTENDED_SPARSE_ADDRESS_SPACE_EXTENSION_NAME

Version History

Revision 1, 2023-10-03 (Russell Chou)
- Initial draft

Document Notes

For more information, see the Vulkan Specification

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

Synopsis

data PhysicalDeviceExtendedSparseAddressSpaceFeaturesNV = PhysicalDeviceExtendedSparseAddressSpaceFeaturesNV {
- extendedSparseAddressSpace :: Bool
}
data PhysicalDeviceExtendedSparseAddressSpacePropertiesNV = PhysicalDeviceExtendedSparseAddressSpacePropertiesNV {
}
type NV_EXTENDED_SPARSE_ADDRESS_SPACE_SPEC_VERSION = 1
pattern NV_EXTENDED_SPARSE_ADDRESS_SPACE_SPEC_VERSION :: forall a. Integral a => a
type NV_EXTENDED_SPARSE_ADDRESS_SPACE_EXTENSION_NAME = "VK_NV_extended_sparse_address_space"
pattern NV_EXTENDED_SPARSE_ADDRESS_SPACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PhysicalDeviceExtendedSparseAddressSpaceFeaturesNV Source #

VkPhysicalDeviceExtendedSparseAddressSpaceFeaturesNV - Structure describing feature to use extended sparse address space

Members

This structure describes the following feature:

Description

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

Valid Usage (Implicit)

PhysicalDeviceExtendedSparseAddressSpaceFeaturesNV
Fields extendedSparseAddressSpace :: Bool `extendedSparseAddressSpace` indicates that the implementation supports allowing certain usages of sparse memory resources to exceed `PhysicalDeviceLimits`::`sparseAddressSpaceSize`. See `PhysicalDeviceExtendedSparseAddressSpacePropertiesNV`.

Instances

Instances details

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

data PhysicalDeviceExtendedSparseAddressSpacePropertiesNV Source #

VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV - Structure describing sparse address space limits of an implementation

Description

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

Valid Usage (Implicit)

extendedSparseAddressSpaceSize :: DeviceSize
extendedSparseAddressSpaceSize is the total amount of address space available, in bytes, for sparse memory resources of all usages if the extendedSparseAddressSpace feature is enabled. This must be greater than or equal to PhysicalDeviceLimits::sparseAddressSpaceSize, and the difference in space must only be used with usages allowed below. This is an upper bound on the sum of the sizes of all sparse resources, regardless of whether any memory is bound to them.
extendedSparseImageUsageFlags :: ImageUsageFlags
extendedSparseImageUsageFlags is a bitmask of ImageUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.
extendedSparseBufferUsageFlags :: BufferUsageFlags
extendedSparseBufferUsageFlags is a bitmask of BufferUsageFlagBits of usages which may allow an implementation to use the full extendedSparseAddressSpaceSize space.

Instances

Instances details

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