Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_VALVE_descriptor_set_host_mapping

Description

Name

VK_VALVE_descriptor_set_host_mapping - device extension

VK_VALVE_descriptor_set_host_mapping

Name String: VK_VALVE_descriptor_set_host_mapping

Extension Type

Device extension

Registered Extension Number

421

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

Special Use

D3D support

Contact

Hans-Kristian Arntzen @HansKristian-Work%0A*Here describe the issue or question you have about the VK_VALVE_descriptor_set_host_mapping extension*

Other Extension Metadata

Last Modified Date: 2022-02-22

IP Status

No known IP claims.

Contributors

Hans-Kristian Arntzen, Valve

Description

This extension allows applications to directly query a host pointer for a DescriptorSet which can be used to copy descriptors between descriptor sets without the use of an API command. Memory offsets and sizes for descriptors can be queried from a DescriptorSetLayout as well.

Note

There is currently no specification language written for this extension. The links to APIs defined by the extension are to stubs that only include generated content such as API declarations and implicit valid usage statements.

Note

This extension is only intended for use in specific embedded environments with known implementation details, and is therefore undocumented.

New Commands

getDescriptorSetHostMappingVALVE

getDescriptorSetLayoutHostMappingInfoVALVE

New Structures

DescriptorSetBindingReferenceVALVE

DescriptorSetLayoutHostMappingInfoVALVE
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceDescriptorSetHostMappingFeaturesVALVE

New Enum Constants

VALVE_DESCRIPTOR_SET_HOST_MAPPING_EXTENSION_NAME

Stub API References

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_VALVE_descriptor_set_host_mapping
void vkGetDescriptorSetLayoutHostMappingInfoVALVE(
    VkDevice                                    device,
    const VkDescriptorSetBindingReferenceVALVE* pBindingReference,
    VkDescriptorSetLayoutHostMappingInfoVALVE*  pHostMapping);

Valid Usage (Implicit)

device must be a valid Device handle

pBindingReference must be a valid pointer to a valid DescriptorSetBindingReferenceVALVE structure
pHostMapping must be a valid pointer to a DescriptorSetLayoutHostMappingInfoVALVE structure

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_VALVE_descriptor_set_host_mapping
void vkGetDescriptorSetHostMappingVALVE(
    VkDevice                                    device,
    VkDescriptorSet                             descriptorSet,
    void**                                      ppData);

Valid Usage (Implicit)

device must be a valid Device handle

descriptorSet must be a valid DescriptorSet handle
ppData must be a valid pointer to a pointer value
descriptorSet must have been created, allocated, or retrieved from device

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_VALVE_descriptor_set_host_mapping
typedef struct VkPhysicalDeviceDescriptorSetHostMappingFeaturesVALVE {
    VkStructureType    sType;
    void*              pNext;
    VkBool32           descriptorSetHostMapping;
} VkPhysicalDeviceDescriptorSetHostMappingFeaturesVALVE;

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_DESCRIPTOR_SET_HOST_MAPPING_FEATURES_VALVE

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_VALVE_descriptor_set_host_mapping
typedef struct VkDescriptorSetBindingReferenceVALVE {
    VkStructureType          sType;
    const void*              pNext;
    VkDescriptorSetLayout    descriptorSetLayout;
    uint32_t                 binding;
} VkDescriptorSetBindingReferenceVALVE;

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_BINDING_REFERENCE_VALVE

pNext must be NULL
descriptorSetLayout must be a valid DescriptorSetLayout handle

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_VALVE_descriptor_set_host_mapping
typedef struct VkDescriptorSetLayoutHostMappingInfoVALVE {
    VkStructureType    sType;
    void*              pNext;
    size_t             descriptorOffset;
    uint32_t           descriptorSize;
} VkDescriptorSetLayoutHostMappingInfoVALVE;

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_HOST_MAPPING_INFO_VALVE

pNext must be NULL

Version History

Revision 1, 2022-02-22 (Hans-Kristian Arntzen)
- Initial specification

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

getDescriptorSetLayoutHostMappingInfoVALVE :: forall io. MonadIO io => Device -> DescriptorSetBindingReferenceVALVE -> io DescriptorSetLayoutHostMappingInfoVALVE
getDescriptorSetHostMappingVALVE :: forall io. MonadIO io => Device -> DescriptorSet -> io ("data" ::: Ptr ())
data PhysicalDeviceDescriptorSetHostMappingFeaturesVALVE = PhysicalDeviceDescriptorSetHostMappingFeaturesVALVE {
- descriptorSetHostMapping :: Bool
}
data DescriptorSetBindingReferenceVALVE = DescriptorSetBindingReferenceVALVE {
- descriptorSetLayout :: DescriptorSetLayout
- binding :: Word32
}
data DescriptorSetLayoutHostMappingInfoVALVE = DescriptorSetLayoutHostMappingInfoVALVE {
- descriptorOffset :: Word64
- descriptorSize :: Word32
}
type VALVE_DESCRIPTOR_SET_HOST_MAPPING_SPEC_VERSION = 1
pattern VALVE_DESCRIPTOR_SET_HOST_MAPPING_SPEC_VERSION :: forall a. Integral a => a
type VALVE_DESCRIPTOR_SET_HOST_MAPPING_EXTENSION_NAME = "VK_VALVE_descriptor_set_host_mapping"
pattern VALVE_DESCRIPTOR_SET_HOST_MAPPING_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getDescriptorSetLayoutHostMappingInfoVALVE Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` must be a valid `Device` handle
-> DescriptorSetBindingReferenceVALVE	`pBindingReference` must be a valid pointer to a valid `DescriptorSetBindingReferenceVALVE` structure
-> io DescriptorSetLayoutHostMappingInfoVALVE

vkGetDescriptorSetLayoutHostMappingInfoVALVE - Stub description of vkGetDescriptorSetLayoutHostMappingInfoVALVE

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

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

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

Name

VK_VALVE_descriptor_set_host_mapping

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Stub API References

Valid Usage (Implicit)

Valid Usage (Implicit)

Valid Usage (Implicit)

Valid Usage (Implicit)

Valid Usage (Implicit)

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceDescriptorSetHostMappingFeaturesVALVE
Fields descriptorSetHostMapping :: Bool

DescriptorSetBindingReferenceVALVE
Fields descriptorSetLayout :: DescriptorSetLayout `descriptorSetLayout` must be a valid `DescriptorSetLayout` handle binding :: Word32

DescriptorSetLayoutHostMappingInfoVALVE
Fields descriptorOffset :: Word64 descriptorSize :: Word32