Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_buffer_device_address

Description

Name

VK_EXT_buffer_device_address - device extension

VK_EXT_buffer_device_address

Name String: VK_EXT_buffer_device_address

Extension Type

Device extension

Registered Extension Number

245

Revision

2

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_get_physical_device_properties2

Deprecation state

Deprecated by VK_KHR_buffer_device_address extension
- Which in turn was promoted to Vulkan 1.2

Contact

Jeff Bolz https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_EXT_buffer_device_address:%20&body=@jeffbolznv%20

Other Extension Metadata

Last Modified Date: 2019-01-06

IP Status

No known IP claims.

Interactions and External Dependencies

This extension requires SPV_EXT_physical_storage_buffer

Contributors

Jeff Bolz, NVIDIA
Neil Henning, AMD
Tobias Hector, AMD
Jason Ekstrand, Intel
Baldur Karlsson, Valve

Description

This extension allows the application to query a 64-bit buffer device address value for a buffer, which can be used to access the buffer memory via the PhysicalStorageBufferEXT storage class in the GL_EXT_buffer_reference GLSL extension and SPV_EXT_physical_storage_buffer SPIR-V extension.

It also allows buffer device addresses to be provided by a trace replay tool, so that it matches the address used when the trace was captured.

New Commands

getBufferDeviceAddressEXT

New Structures

BufferDeviceAddressInfoEXT

Extending BufferCreateInfo:
- BufferDeviceAddressCreateInfoEXT
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceBufferDeviceAddressFeaturesEXT

New Enum Constants

EXT_BUFFER_DEVICE_ADDRESS_EXTENSION_NAME

EXT_BUFFER_DEVICE_ADDRESS_SPEC_VERSION
Extending BufferCreateFlagBits:
- BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT
Extending BufferUsageFlagBits:
- BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT
Extending Result:
- ERROR_INVALID_DEVICE_ADDRESS_EXT
Extending StructureType:

New SPIR-V Capabilities

PhysicalStorageBufferAddressesEXT

Issues

1) Where is VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_ADDRESS_FEATURES_EXT and VkPhysicalDeviceBufferAddressFeaturesEXT?

RESOLVED: They were renamed as STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES_EXT and PhysicalDeviceBufferDeviceAddressFeaturesEXT accordingly for consistency. Even though, the old names can still be found in the generated header files for compatibility.

Version History

Revision 1, 2018-11-01 (Jeff Bolz)
- Internal revisions

Revision 2, 2019-01-06 (Jon Leech)
- Minor updates to appendix for publication

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

pattern STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_ADDRESS_FEATURES_EXT :: StructureType
pattern STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO_EXT :: StructureType
pattern BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT :: BufferUsageFlagBits
pattern BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT :: BufferCreateFlagBits
pattern ERROR_INVALID_DEVICE_ADDRESS_EXT :: Result
getBufferDeviceAddressEXT :: MonadIO io => Device -> BufferDeviceAddressInfo -> io DeviceAddress
data PhysicalDeviceBufferDeviceAddressFeaturesEXT = PhysicalDeviceBufferDeviceAddressFeaturesEXT {
}
data BufferDeviceAddressCreateInfoEXT = BufferDeviceAddressCreateInfoEXT {
- deviceAddress :: DeviceAddress
}
type PhysicalDeviceBufferAddressFeaturesEXT = PhysicalDeviceBufferDeviceAddressFeaturesEXT
type BufferDeviceAddressInfoEXT = BufferDeviceAddressInfo
type EXT_BUFFER_DEVICE_ADDRESS_SPEC_VERSION = 2
pattern EXT_BUFFER_DEVICE_ADDRESS_SPEC_VERSION :: forall a. Integral a => a
type EXT_BUFFER_DEVICE_ADDRESS_EXTENSION_NAME = "VK_EXT_buffer_device_address"
pattern EXT_BUFFER_DEVICE_ADDRESS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

pattern STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_ADDRESS_FEATURES_EXT :: StructureType Source #

pattern STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO_EXT :: StructureType Source #

pattern BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT :: BufferUsageFlagBits Source #

pattern BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT :: BufferCreateFlagBits Source #

pattern ERROR_INVALID_DEVICE_ADDRESS_EXT :: Result Source #

getBufferDeviceAddressEXT :: MonadIO io => Device -> BufferDeviceAddressInfo -> io DeviceAddress Source #

data PhysicalDeviceBufferDeviceAddressFeaturesEXT Source #

VkPhysicalDeviceBufferDeviceAddressFeaturesEXT - Structure describing buffer address features that can be supported by an implementation

Members

The members of the PhysicalDeviceBufferDeviceAddressFeaturesEXT structure describe the following features:

Description

If the PhysicalDeviceBufferDeviceAddressFeaturesEXT structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceBufferDeviceAddressFeaturesEXT can also be included in the pNext chain of DeviceCreateInfo to enable features.

Note

The PhysicalDeviceBufferDeviceAddressFeaturesEXT structure has the same members as the PhysicalDeviceBufferDeviceAddressFeatures structure, but the functionality indicated by the members is expressed differently. The features indicated by the PhysicalDeviceBufferDeviceAddressFeatures structure requires additional flags to be passed at memory allocation time, and the capture and replay mechanism is built around opaque capture addresses for buffer and memory objects.

Valid Usage (Implicit)

bufferDeviceAddress :: Bool
bufferDeviceAddress indicates that the implementation supports accessing buffer memory in shaders as storage buffers via an address queried from getBufferDeviceAddressEXT.
bufferDeviceAddressCaptureReplay :: Bool
bufferDeviceAddressCaptureReplay indicates that the implementation supports saving and reusing buffer addresses, e.g. for trace capture and replay.
bufferDeviceAddressMultiDevice :: Bool
bufferDeviceAddressMultiDevice indicates that the implementation supports the bufferDeviceAddress feature for logical devices created with multiple physical devices. If this feature is not supported, buffer addresses must not be queried on a logical device created with more than one physical device.

Instances

Instances details

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

data BufferDeviceAddressCreateInfoEXT Source #

VkBufferDeviceAddressCreateInfoEXT - Request a specific address for a buffer

Description

If deviceAddress is zero, no specific address is requested.

If deviceAddress is not zero, then it must be an address retrieved from an identically created buffer on the same implementation. The buffer must also be bound to an identically created DeviceMemory object.

If this structure is not present, it is as if deviceAddress is zero.

Apps should avoid creating buffers with app-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_DEVICE_ADDRESS_EXT errors.

Valid Usage (Implicit)

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