vkGetMemoryWin32HandlePropertiesKHR(3)

# vkGetMemoryWin32HandlePropertiesKHR(3) Manual Page

## Name

vkGetMemoryWin32HandlePropertiesKHR - Get Properties of External Memory Win32 Handles

## C Specification

Windows memory handles compatible with Vulkan may also be created by non-Vulkan APIs using methods beyond the scope of this specification. To determine the correct parameters to use when importing such handles, call:

    VkResult vkGetMemoryWin32HandlePropertiesKHR(
        VkDevice                                    device,
        VkExternalMemoryHandleTypeFlagBits          handleType,
        HANDLE                                      handle,
        VkMemoryWin32HandlePropertiesKHR*           pMemoryWin32HandleProperties);

## Parameters

- `device` is the logical device that will be importing `handle`.

- `handleType` is the type of the handle `handle`.

- `handle` is the handle which will be imported.

- `pMemoryWin32HandleProperties` will return properties of `handle`.

## Description

Valid Usage

- `handle` must be an external memory handle created outside of the Vulkan API.

- `handleType` must not be one of the handle types defined as opaque.

Valid Usage (Implicit)

- `device` must be a valid VkDevice handle

- `handleType` must be a valid VkExternalMemoryHandleTypeFlagBits value

- `pMemoryWin32HandleProperties` must be a valid pointer to a VkMemoryWin32HandlePropertiesKHR structure

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_INVALID_EXTERNAL_HANDLE`

## See Also

VkDevice, VkExternalMemoryHandleTypeFlagBits, VkMemoryWin32HandlePropertiesKHR

## 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 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.