vkGetBufferDeviceAddressKHR(3)

# vkGetBufferDeviceAddressKHR(3) Manual Page

## Name

vkGetBufferDeviceAddressKHR - Query an address of a buffer

## C Specification

To query a 64-bit buffer device address value through which buffer memory can be accessed in a shader, call:

    VkDeviceAddress vkGetBufferDeviceAddressKHR(
        VkDevice                                    device,
        const VkBufferDeviceAddressInfoKHR*         pInfo);

or the equivalent command

    VkDeviceAddress vkGetBufferDeviceAddressEXT(
        VkDevice                                    device,
        const VkBufferDeviceAddressInfoKHR*         pInfo);

## Parameters

- `device` is the logical device that the buffer was created on.

- `pInfo` is a pointer to a VkBufferDeviceAddressInfoKHR structure specifying the buffer to retrieve an address for.

## Description

The 64-bit return value is an address of the start of `pInfo`::`buffer`. The address range starting at this value and whose size is the size of the buffer can be used in a shader to access the memory bound to that buffer, using the `SPV_KHR_physical_storage_buffer` extension or the equivalent `SPV_EXT_physical_storage_buffer` extension and the `PhysicalStorageBuffer` storage class. For example, this value can be stored in a uniform buffer, and the shader can read the value from the uniform buffer and use it to do a dependent read/write to this buffer. A value of zero is reserved as a “null” pointer and must not be returned as a valid buffer device address. All loads, stores, and atomics in a shader through `PhysicalStorageBuffer` pointers must access addresses in the address range of some buffer.

If the buffer was created with a non-zero value of VkBufferOpaqueCaptureAddressCreateInfoKHR::`opaqueCaptureAddress` or VkBufferDeviceAddressCreateInfoEXT::`deviceAddress` the return value will be the same address that was returned at capture time.

Valid Usage

- The bufferDeviceAddress or `VkPhysicalDeviceBufferDeviceAddressFeaturesEXT`::`bufferDeviceAddress` feature must be enabled

- If `device` was created with multiple physical devices, then the bufferDeviceAddressMultiDevice or `VkPhysicalDeviceBufferDeviceAddressFeaturesEXT`::`bufferDeviceAddressMultiDevice` feature must be enabled

Valid Usage (Implicit)

- `device` must be a valid `VkDevice` handle

- `pInfo` must be a valid pointer to a valid `VkBufferDeviceAddressInfoKHR` structure

## See Also

VkBufferDeviceAddressInfoKHR, VkDevice

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.