vkGetMemoryRemoteAddressNV(3)

# vkGetMemoryRemoteAddressNV(3) Manual Page

## Name

vkGetMemoryRemoteAddressNV - Get an address for a memory object accessible by remote devices

Loading… please wait.

## C Specification

To export an address representing the payload of a Vulkan device memory object accessible by remote devices, call:

    // Provided by VK_NV_external_memory_rdma
    VkResult vkGetMemoryRemoteAddressNV(
        VkDevice                                    device,
        const VkMemoryGetRemoteAddressInfoNV*       pMemoryGetRemoteAddressInfo,
        VkRemoteAddressNV*                          pAddress);

## Parameters

- `device` is the logical device that created the device memory being exported.

- `pMemoryGetRemoteAddressInfo` is a pointer to a VkMemoryGetRemoteAddressInfoNV structure containing parameters of the export operation.

- `pAddress` will return the address representing the payload of the device memory object.

## Description

More communication may be required between the kernel-mode drivers of the devices involved. This information is out of scope of this documentation and should be requested from the vendors of the devices.

Valid Usage (Implicit)

- VUID-vkGetMemoryRemoteAddressNV-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkGetMemoryRemoteAddressNV-pMemoryGetRemoteAddressInfo-parameter
  `pMemoryGetRemoteAddressInfo` must be a valid pointer to a valid VkMemoryGetRemoteAddressInfoNV structure

- VUID-vkGetMemoryRemoteAddressNV-pAddress-parameter
  `pAddress` must be a valid pointer to a `VkRemoteAddressNV` value

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_INVALID_EXTERNAL_HANDLE`

## See Also

VK_NV_external_memory_rdma, VkDevice, VkMemoryGetRemoteAddressInfoNV, `VkRemoteAddressNV`

## 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 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0