Vulkan.Extensions.VK_EXT_private_data

Name

VK_EXT_private_data - device extension

VK_EXT_private_data

Name String

VK_EXT_private_data

Extension Type

Device extension

Registered Extension Number

296

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Deprecation state

• Promoted to Vulkan 1.3

Contact

• Matthew Rusch @mattruschnv%0A*Here describe the issue or question you have about the VK_EXT_private_data extension*

Other Extension Metadata

Last Modified Date

2020-03-25

Interactions and External Dependencies

• Promoted to Vulkan 1.3 Core

IP Status

No known IP claims.

Contributors

• Matthew Rusch, NVIDIA
• Nuno Subtil, NVIDIA
• Piers Daniell, NVIDIA
• Jeff Bolz, NVIDIA

Description

This extension is a device extension which enables attaching arbitrary payloads to Vulkan objects. It introduces the idea of private data slots as a means of storing a 64-bit unsigned integer of application defined data. Private data slots can be created or destroyed any time an associated device is available. Private data slots can be reserved at device creation time, and limiting use to the amount reserved will allow the extension to exhibit better performance characteristics.

New Object Types

• PrivateDataSlotEXT

New Commands

• createPrivateDataSlotEXT

• destroyPrivateDataSlotEXT
• getPrivateDataEXT
• setPrivateDataEXT

New Structures

• PrivateDataSlotCreateInfoEXT

• Extending DeviceCreateInfo:

  • DevicePrivateDataCreateInfoEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDevicePrivateDataFeaturesEXT

New Bitmasks

• PrivateDataSlotCreateFlagsEXT

New Enum Constants

• EXT_PRIVATE_DATA_EXTENSION_NAME

• EXT_PRIVATE_DATA_SPEC_VERSION

• Extending ObjectType:

  • OBJECT_TYPE_PRIVATE_DATA_SLOT_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_PRIVATE_DATA_CREATE_INFO_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_PRIVATE_DATA_FEATURES_EXT
  • STRUCTURE_TYPE_PRIVATE_DATA_SLOT_CREATE_INFO_EXT

Promotion to Vulkan 1.3

Functionality in this extension is included in core Vulkan 1.3, with the EXT suffix omitted. The original type, enum and command names are still available as aliases of the core functionality.

Examples

• In progress

Issues

1. If I have to create a PrivateDataSlot to store and retrieve data on an object, how does this extension help me? Will I not need to store the PrivateDataSlot mapping with each object, and if I am doing that, I might as well just store the original data!

RESOLVED: The PrivateDataSlot can be thought of as an opaque index into storage that is reserved in each object. That is, you can use the same PrivateDataSlot with each object for a specific piece of information. For example, if a layer wishes to track per-object information, the layer only needs to allocate one PrivateDataSlot per device and it can use that private data slot for all of the device’s child objects. This allows multiple layers to store private data without conflicting with each other’s and/or the application’s private data.

1. What if I need to store more than 64-bits of information per object?

RESOLVED: The data that you store per object could be a pointer to another object or structure of your own allocation.

Version History

• Revision 1, 2020-01-15 (Matthew Rusch)

  • Initial draft

See Also

DevicePrivateDataCreateInfoEXT, PhysicalDevicePrivateDataFeaturesEXT, PrivateDataSlotCreateFlagsEXT, PrivateDataSlotCreateInfoEXT, PrivateDataSlotEXT, createPrivateDataSlotEXT, destroyPrivateDataSlotEXT, getPrivateDataEXT, setPrivateDataEXT

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_PRIVATE_DATA_FEATURES_EXT :: StructureType

pattern STRUCTURE_TYPE_DEVICE_PRIVATE_DATA_CREATE_INFO_EXT :: StructureType

pattern STRUCTURE_TYPE_PRIVATE_DATA_SLOT_CREATE_INFO_EXT :: StructureType

pattern OBJECT_TYPE_PRIVATE_DATA_SLOT_EXT :: ObjectType

createPrivateDataSlotEXT :: MonadIO io => Device -> PrivateDataSlotCreateInfo -> ("allocator" ::: Maybe AllocationCallbacks) -> io PrivateDataSlot

destroyPrivateDataSlotEXT :: MonadIO io => Device -> PrivateDataSlot -> ("allocator" ::: Maybe AllocationCallbacks) -> io ()

setPrivateDataEXT :: MonadIO io => Device -> ObjectType -> ("objectHandle" ::: Word64) -> PrivateDataSlot -> ("data" ::: Word64) -> io ()

getPrivateDataEXT :: MonadIO io => Device -> ObjectType -> ("objectHandle" ::: Word64) -> PrivateDataSlot -> io ("data" ::: Word64)

type PrivateDataSlotCreateFlagsEXT = PrivateDataSlotCreateFlags

type PrivateDataSlotEXT = PrivateDataSlot

type DevicePrivateDataCreateInfoEXT = DevicePrivateDataCreateInfo

type PrivateDataSlotCreateInfoEXT = PrivateDataSlotCreateInfo

type PhysicalDevicePrivateDataFeaturesEXT = PhysicalDevicePrivateDataFeatures

type EXT_PRIVATE_DATA_SPEC_VERSION = 1

pattern EXT_PRIVATE_DATA_SPEC_VERSION :: forall a. Integral a => a

type EXT_PRIVATE_DATA_EXTENSION_NAME = "VK_EXT_private_data"

pattern EXT_PRIVATE_DATA_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a