vkGetMemoryZirconHandlePropertiesFUCHSIA(3)

# vkGetMemoryZirconHandlePropertiesFUCHSIA(3) Manual Page

## Name

vkGetMemoryZirconHandlePropertiesFUCHSIA - Get a Zircon handle properties for an external memory object

Loading… please wait.

## C Specification

To obtain the memoryTypeIndex for the VkMemoryAllocateInfo structure, call `vkGetMemoryZirconHandlePropertiesFUCHSIA`:

    // Provided by VK_FUCHSIA_external_memory
    VkResult vkGetMemoryZirconHandlePropertiesFUCHSIA(
        VkDevice                                    device,
        VkExternalMemoryHandleTypeFlagBits          handleType,
        zx_handle_t                                 zirconHandle,
        VkMemoryZirconHandlePropertiesFUCHSIA*      pMemoryZirconHandleProperties);

## Parameters

- `device` is the VkDevice.

- `handleType` is a VkExternalMemoryHandleTypeFlagBits value specifying the type of `zirconHandle`

- `zirconHandle` is a `zx_handle_t` (Zircon) handle to the external resource.

- `pMemoryZirconHandleProperties` is a pointer to a VkMemoryZirconHandlePropertiesFUCHSIA structure in which the result will be stored.

## Description

Valid Usage

- VUID-vkGetMemoryZirconHandlePropertiesFUCHSIA-handleType-04773
  `handleType` must be `VK_EXTERNAL_MEMORY_HANDLE_TYPE_ZIRCON_VMO_BIT_FUCHSIA`

- VUID-vkGetMemoryZirconHandlePropertiesFUCHSIA-zirconHandle-04774
  `zirconHandle` must reference a valid VMO

Valid Usage (Implicit)

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

- VUID-vkGetMemoryZirconHandlePropertiesFUCHSIA-handleType-parameter
  `handleType` must be a valid VkExternalMemoryHandleTypeFlagBits value

- VUID-vkGetMemoryZirconHandlePropertiesFUCHSIA-pMemoryZirconHandleProperties-parameter
  `pMemoryZirconHandleProperties` must be a valid pointer to a VkMemoryZirconHandlePropertiesFUCHSIA structure

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_INVALID_EXTERNAL_HANDLE`

## See Also

VK_FUCHSIA_external_memory, VkDevice, VkExternalMemoryHandleTypeFlagBits, VkMemoryZirconHandlePropertiesFUCHSIA

## 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