# vkGetMemoryZirconHandleFUCHSIA(3) Manual Page

## Name

vkGetMemoryZirconHandleFUCHSIA - Get a Zircon handle for an external memory object

Loading… please wait.

## C Specification

To export device memory as a Zircon handle that can be used by another instance, device, or process, retrieve the handle to the VkDeviceMemory using the command:

    // Provided by VK_FUCHSIA_external_memory
    VkResult vkGetMemoryZirconHandleFUCHSIA(
        VkDevice                                    device,
        const VkMemoryGetZirconHandleInfoFUCHSIA*   pGetZirconHandleInfo,
        zx_handle_t*                                pZirconHandle);

## Parameters

- `device` is the VkDevice.

- `pGetZirconHandleInfo` is a pointer to a VkMemoryGetZirconHandleInfoFUCHSIA structure.

- `pZirconHandle` is a pointer to a `zx_handle_t` which holds the resulting Zircon handle.

## Description

Valid Usage (Implicit)

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

- VUID-vkGetMemoryZirconHandleFUCHSIA-pGetZirconHandleInfo-parameter
  `pGetZirconHandleInfo` must be a valid pointer to a valid VkMemoryGetZirconHandleInfoFUCHSIA structure

- VUID-vkGetMemoryZirconHandleFUCHSIA-pZirconHandle-parameter
  `pZirconHandle` must be a valid pointer to a `zx_handle_t` value

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_TOO_MANY_OBJECTS`

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

## See Also

VK_FUCHSIA_external_memory, VkDevice, VkMemoryGetZirconHandleInfoFUCHSIA

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

SPDX-License-Identifier: CC-BY-4.0