Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_VALVE_mutable_descriptor_type

Description

Name

VK_VALVE_mutable_descriptor_type - device extension

VK_VALVE_mutable_descriptor_type

Name String: VK_VALVE_mutable_descriptor_type

Extension Type

Device extension

Registered Extension Number

352

Revision

1

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_maintenance3

Special Use

D3D support

Contact

Joshua Ashton @Joshua-Ashton%0A<<Here describe the issue or question you have about the VK_VALVE_mutable_descriptor_type extension> >
Hans-Kristian Arntzen @HansKristian-Work%0A<<Here describe the issue or question you have about the VK_VALVE_mutable_descriptor_type extension> >

Other Extension Metadata

Last Modified Date: 2020-12-02

IP Status

No known IP claims.

Contributors

Joshua Ashton, Valve
Hans-Kristian Arntzen, Valve

Description

This extension allows applications to reduce descriptor memory footprint by allowing a descriptor to be able to mutate to a given list of descriptor types depending on which descriptor types are written into, or copied into a descriptor set.

The main use case this extension intends to address is descriptor indexing with DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT where the descriptor types are completely generic, as this means applications can allocate one large descriptor set, rather than having one large descriptor set per descriptor type, which significantly bloats descriptor memory usage and causes performance issues.

This extension also adds a mechanism to declare that a descriptor pool, and therefore the descriptor sets that are allocated from it, reside only in host memory; as such these descriptors can only be updated/copied, but not bound.

These features together allow much more efficient emulation of the raw D3D12 binding model. This extension is primarily intended to be useful for API layering efforts.

New Structures

MutableDescriptorTypeListVALVE

Extending DescriptorSetLayoutCreateInfo, DescriptorPoolCreateInfo:
- MutableDescriptorTypeCreateInfoVALVE
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceMutableDescriptorTypeFeaturesVALVE

New Enum Constants

VALVE_MUTABLE_DESCRIPTOR_TYPE_EXTENSION_NAME

VALVE_MUTABLE_DESCRIPTOR_TYPE_SPEC_VERSION
Extending DescriptorPoolCreateFlagBits:
- DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_VALVE
Extending DescriptorSetLayoutCreateFlagBits:
- DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE
Extending DescriptorType:
- DESCRIPTOR_TYPE_MUTABLE_VALVE
Extending StructureType:
- STRUCTURE_TYPE_MUTABLE_DESCRIPTOR_TYPE_CREATE_INFO_VALVE
- STRUCTURE_TYPE_PHYSICAL_DEVICE_MUTABLE_DESCRIPTOR_TYPE_FEATURES_VALVE

Version History

Revision 1, 2020-12-01 (Joshua Ashton, Hans-Kristian Arntzen)
- Initial specification, squashed from public 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 PhysicalDeviceMutableDescriptorTypeFeaturesVALVE = PhysicalDeviceMutableDescriptorTypeFeaturesVALVE {
- mutableDescriptorType :: Bool
}
data MutableDescriptorTypeListVALVE = MutableDescriptorTypeListVALVE {
- descriptorTypes :: Vector DescriptorType
}
data MutableDescriptorTypeCreateInfoVALVE = MutableDescriptorTypeCreateInfoVALVE {
- mutableDescriptorTypeLists :: Vector MutableDescriptorTypeListVALVE
}
type VALVE_MUTABLE_DESCRIPTOR_TYPE_SPEC_VERSION = 1
pattern VALVE_MUTABLE_DESCRIPTOR_TYPE_SPEC_VERSION :: forall a. Integral a => a
type VALVE_MUTABLE_DESCRIPTOR_TYPE_EXTENSION_NAME = "VK_VALVE_mutable_descriptor_type"
pattern VALVE_MUTABLE_DESCRIPTOR_TYPE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PhysicalDeviceMutableDescriptorTypeFeaturesVALVE Source #

VkPhysicalDeviceMutableDescriptorTypeFeaturesVALVE - Structure describing whether the mutable descriptor type is supported

Members

This structure describes the following feature:

Description

sType is the type of this structure.

pNext is NULL or a pointer to a structure extending this structure.
mutableDescriptorType indicates that the implementation must support using the DescriptorType of DESCRIPTOR_TYPE_MUTABLE_VALVE with at least the following descriptor types, where any combination of the types must be supported:
Additionally, mutableDescriptorType indicates that:
- Non-uniform descriptor indexing must be supported if all descriptor types in a MutableDescriptorTypeListVALVE for DESCRIPTOR_TYPE_MUTABLE_VALVE have the corresponding non-uniform indexing features enabled in PhysicalDeviceDescriptorIndexingFeatures.
- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT with descriptorType of DESCRIPTOR_TYPE_MUTABLE_VALVE relaxes the list of required descriptor types to the descriptor types which have the corresponding update-after-bind feature enabled in PhysicalDeviceDescriptorIndexingFeatures.
- Dynamically uniform descriptor indexing must be supported if all descriptor types in a MutableDescriptorTypeListVALVE for DESCRIPTOR_TYPE_MUTABLE_VALVE have the corresponding dynamic indexing features enabled.
- DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE must be supported.
- DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_VALVE must be supported.

If the PhysicalDeviceMutableDescriptorTypeFeaturesVALVE 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. PhysicalDeviceMutableDescriptorTypeFeaturesVALVE can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_MUTABLE_DESCRIPTOR_TYPE_FEATURES_VALVE

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

data MutableDescriptorTypeListVALVE Source #

VkMutableDescriptorTypeListVALVE - Structure describing descriptor types that a given descriptor may mutate to

Valid Usage

descriptorTypeCount must not be 0 if the corresponding binding is of DESCRIPTOR_TYPE_MUTABLE_VALVE

pDescriptorTypes must be a valid pointer to an array of descriptorTypeCount valid, unique DescriptorType values if the given binding is of DESCRIPTOR_TYPE_MUTABLE_VALVE type
descriptorTypeCount must be 0 if the corresponding binding is not of DESCRIPTOR_TYPE_MUTABLE_VALVE
pDescriptorTypes must not contain DESCRIPTOR_TYPE_MUTABLE_VALVE
pDescriptorTypes must not contain DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
pDescriptorTypes must not contain DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC
pDescriptorTypes must not contain DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT

Valid Usage (Implicit)

If descriptorTypeCount is not 0, pDescriptorTypes must be a valid pointer to an array of descriptorTypeCount valid DescriptorType values

Description

If mutableDescriptorTypeListCount is zero or if this structure is not included in the pNext chain, the MutableDescriptorTypeListVALVE for each element is considered to be zero or NULL for each member. Otherwise, the descriptor set layout binding at DescriptorSetLayoutCreateInfo::pBindings[i] uses the descriptor type lists in MutableDescriptorTypeCreateInfoVALVE::pMutableDescriptorTypeLists[i].

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_MUTABLE_DESCRIPTOR_TYPE_CREATE_INFO_VALVE

If mutableDescriptorTypeListCount is not 0, pMutableDescriptorTypeLists must be a valid pointer to an array of mutableDescriptorTypeListCount valid MutableDescriptorTypeListVALVE structures

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

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

Name

VK_VALVE_mutable_descriptor_type

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceMutableDescriptorTypeFeaturesVALVE
Fields mutableDescriptorType :: Bool

MutableDescriptorTypeListVALVE
Fields descriptorTypes :: Vector DescriptorType `pDescriptorTypes` is `NULL` or a pointer to an array of `descriptorTypeCount` `DescriptorType` values defining which descriptor types a given binding may mutate to.

MutableDescriptorTypeCreateInfoVALVE
Fields mutableDescriptorTypeLists :: Vector MutableDescriptorTypeListVALVE `pMutableDescriptorTypeLists` is a pointer to an array of `MutableDescriptorTypeListVALVE` structures.