Vulkan.Extensions.VK_VALVE_mutable_descriptor_type

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 support for Vulkan 1.0
• Requires VK_KHR_maintenance3 to be enabled for any device-level functionality

Deprecation state

• Promoted to VK_EXT_mutable_descriptor_type extension

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.

See Also

MutableDescriptorTypeCreateInfoVALVE, MutableDescriptorTypeListVALVE, PhysicalDeviceMutableDescriptorTypeFeaturesVALVE

Document Notes

For more information, see the Vulkan Specification

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

Documentation

pattern STRUCTURE_TYPE_PHYSICAL_DEVICE_MUTABLE_DESCRIPTOR_TYPE_FEATURES_VALVE :: StructureType

pattern STRUCTURE_TYPE_MUTABLE_DESCRIPTOR_TYPE_CREATE_INFO_VALVE :: StructureType

pattern DESCRIPTOR_TYPE_MUTABLE_VALVE :: DescriptorType

pattern DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_VALVE :: DescriptorPoolCreateFlagBits

pattern DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVE :: DescriptorSetLayoutCreateFlagBits

type PhysicalDeviceMutableDescriptorTypeFeaturesVALVE = PhysicalDeviceMutableDescriptorTypeFeaturesEXT

type MutableDescriptorTypeListVALVE = MutableDescriptorTypeListEXT

type MutableDescriptorTypeCreateInfoVALVE = MutableDescriptorTypeCreateInfoEXT

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

data PhysicalDeviceMutableDescriptorTypeFeaturesEXT

VkPhysicalDeviceMutableDescriptorTypeFeaturesEXT - 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_EXT with at least the following descriptor types, where any combination of the types must be supported:

  • DESCRIPTOR_TYPE_SAMPLED_IMAGE
  • DESCRIPTOR_TYPE_STORAGE_IMAGE
  • DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER
  • DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER
  • DESCRIPTOR_TYPE_UNIFORM_BUFFER
  • DESCRIPTOR_TYPE_STORAGE_BUFFER

• Additionally, mutableDescriptorType indicates that:

  • Non-uniform descriptor indexing must be supported if all descriptor types in a MutableDescriptorTypeListEXT for DESCRIPTOR_TYPE_MUTABLE_EXT have the corresponding non-uniform indexing features enabled in PhysicalDeviceDescriptorIndexingFeatures.
  • DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT with descriptorType of DESCRIPTOR_TYPE_MUTABLE_EXT 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 MutableDescriptorTypeListEXT for DESCRIPTOR_TYPE_MUTABLE_EXT have the corresponding dynamic indexing features enabled.
  • DESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_EXT must be supported.
  • DESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_EXT must be supported.

If the PhysicalDeviceMutableDescriptorTypeFeaturesEXT 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. PhysicalDeviceMutableDescriptorTypeFeaturesEXT 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_EXT

See Also

VK_EXT_mutable_descriptor_type, VK_VALVE_mutable_descriptor_type, Bool32, StructureType

Constructors

PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Fields

• mutableDescriptorType :: Bool

Instances

Storable PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

sizeOf :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> Int

alignment :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> Int -> IO PhysicalDeviceMutableDescriptorTypeFeaturesEXT

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

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

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

peek :: Ptr PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> IO PhysicalDeviceMutableDescriptorTypeFeaturesEXT

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

Show PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

showsPrec :: Int -> PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> ShowS

show :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> String

showList :: [PhysicalDeviceMutableDescriptorTypeFeaturesEXT] -> ShowS

Eq PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

(==) :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> Bool

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

FromCStruct PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

peekCStruct :: Ptr PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> IO PhysicalDeviceMutableDescriptorTypeFeaturesEXT

ToCStruct PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

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

pokeCStruct :: Ptr PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceMutableDescriptorTypeFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMutableDescriptorTypeFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

zero :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT

data MutableDescriptorTypeListEXT

VkMutableDescriptorTypeListEXT - 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_EXT

• pDescriptorTypes must be a valid pointer to an array of descriptorTypeCount valid, unique DescriptorType values if the given binding is of DESCRIPTOR_TYPE_MUTABLE_EXT type
• descriptorTypeCount must be 0 if the corresponding binding is not of DESCRIPTOR_TYPE_MUTABLE_EXT
• pDescriptorTypes must not contain DESCRIPTOR_TYPE_MUTABLE_EXT
• 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

Valid Usage (Implicit)

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

See Also

VK_EXT_mutable_descriptor_type, VK_VALVE_mutable_descriptor_type, DescriptorType, MutableDescriptorTypeCreateInfoEXT

Constructors

MutableDescriptorTypeListEXT

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.

Instances

Show MutableDescriptorTypeListEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

showsPrec :: Int -> MutableDescriptorTypeListEXT -> ShowS

show :: MutableDescriptorTypeListEXT -> String

showList :: [MutableDescriptorTypeListEXT] -> ShowS

FromCStruct MutableDescriptorTypeListEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

peekCStruct :: Ptr MutableDescriptorTypeListEXT -> IO MutableDescriptorTypeListEXT

ToCStruct MutableDescriptorTypeListEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

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

pokeCStruct :: Ptr MutableDescriptorTypeListEXT -> MutableDescriptorTypeListEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MutableDescriptorTypeListEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MutableDescriptorTypeListEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

zero :: MutableDescriptorTypeListEXT

data MutableDescriptorTypeCreateInfoEXT

VkMutableDescriptorTypeCreateInfoEXT - Structure describing the list of possible active descriptor types for mutable type descriptors

Description

If mutableDescriptorTypeListCount is zero or if this structure is not included in the pNext chain, the MutableDescriptorTypeListEXT 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 MutableDescriptorTypeCreateInfoEXT::pMutableDescriptorTypeLists[i].

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MUTABLE_DESCRIPTOR_TYPE_CREATE_INFO_EXT

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

See Also

VK_EXT_mutable_descriptor_type, VK_VALVE_mutable_descriptor_type, MutableDescriptorTypeListEXT, StructureType

Constructors

MutableDescriptorTypeCreateInfoEXT

Fields

• mutableDescriptorTypeLists :: Vector MutableDescriptorTypeListEXT

  pMutableDescriptorTypeLists is a pointer to an array of MutableDescriptorTypeListEXT structures.

Instances

Show MutableDescriptorTypeCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

showsPrec :: Int -> MutableDescriptorTypeCreateInfoEXT -> ShowS

show :: MutableDescriptorTypeCreateInfoEXT -> String

showList :: [MutableDescriptorTypeCreateInfoEXT] -> ShowS

FromCStruct MutableDescriptorTypeCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

peekCStruct :: Ptr MutableDescriptorTypeCreateInfoEXT -> IO MutableDescriptorTypeCreateInfoEXT

ToCStruct MutableDescriptorTypeCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

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

pokeCStruct :: Ptr MutableDescriptorTypeCreateInfoEXT -> MutableDescriptorTypeCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MutableDescriptorTypeCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MutableDescriptorTypeCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_mutable_descriptor_type

Methods

zero :: MutableDescriptorTypeCreateInfoEXT