vkGetDeviceGroupPeerMemoryFeatures(3)

# vkGetDeviceGroupPeerMemoryFeatures(3) Manual Page

## Name

vkGetDeviceGroupPeerMemoryFeatures - Query supported peer memory features of a device

Loading… please wait.

## C Specification

Peer memory is memory that is allocated for a given physical device and then bound to a resource and accessed by a different physical device, in a logical device that represents multiple physical devices. Some ways of reading and writing peer memory may not be supported by a device.

To determine how peer memory can be accessed, call:

    // Provided by VK_VERSION_1_1
    void vkGetDeviceGroupPeerMemoryFeatures(
        VkDevice                                    device,
        uint32_t                                    heapIndex,
        uint32_t                                    localDeviceIndex,
        uint32_t                                    remoteDeviceIndex,
        VkPeerMemoryFeatureFlags*                   pPeerMemoryFeatures);

or the equivalent command

    // Provided by VK_KHR_device_group
    void vkGetDeviceGroupPeerMemoryFeaturesKHR(
        VkDevice                                    device,
        uint32_t                                    heapIndex,
        uint32_t                                    localDeviceIndex,
        uint32_t                                    remoteDeviceIndex,
        VkPeerMemoryFeatureFlags*                   pPeerMemoryFeatures);

## Parameters

- `device` is the logical device that owns the memory.

- `heapIndex` is the index of the memory heap from which the memory is allocated.

- `localDeviceIndex` is the device index of the physical device that performs the memory access.

- `remoteDeviceIndex` is the device index of the physical device that the memory is allocated for.

- `pPeerMemoryFeatures` is a pointer to a VkPeerMemoryFeatureFlags bitmask indicating which types of memory accesses are supported for the combination of heap, local, and remote devices.

## Description

Valid Usage

- `heapIndex` must be less than `memoryHeapCount`

- `localDeviceIndex` must be a valid device index

- `remoteDeviceIndex` must be a valid device index

- `localDeviceIndex` must not equal `remoteDeviceIndex`

Valid Usage (Implicit)

- `device` must be a valid VkDevice handle

- `pPeerMemoryFeatures` must be a valid pointer to a VkPeerMemoryFeatureFlags value

## See Also

VkDevice, VkPeerMemoryFeatureFlags

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

SPDX-License-Identifier: CC-BY-4.0