VkFenceGetWin32HandleInfoKHR(3)

# VkFenceGetWin32HandleInfoKHR(3) Manual Page

## Name

VkFenceGetWin32HandleInfoKHR - Structure describing a Win32 handle fence export operation

## C Specification

The `VkFenceGetWin32HandleInfoKHR` structure is defined as:

    typedef struct VkFenceGetWin32HandleInfoKHR {
        VkStructureType                      sType;
        const void*                          pNext;
        VkFence                              fence;
        VkExternalFenceHandleTypeFlagBits    handleType;
    } VkFenceGetWin32HandleInfoKHR;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to an extension-specific structure.

- `fence` is the fence from which state will be exported.

- `handleType` is the type of handle requested.

## Description

The properties of the handle returned depend on the value of `handleType`. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

Valid Usage

- `handleType` must have been included in VkExportFenceCreateInfo::`handleTypes` when the `fence`’s current payload was created.

- If `handleType` is defined as an NT handle, vkGetFenceWin32HandleKHR must be called no more than once for each valid unique combination of `fence` and `handleType`.

- `fence` must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in VkExternalFenceProperties::`exportFromImportedHandleTypes` for `handleType`.

- If `handleType` refers to a handle type with copy payload transference semantics, `fence` must be signaled, or have an associated fence signal operation pending execution.

- `handleType` must be defined as an NT handle or a global share handle.

Valid Usage (Implicit)

- `sType` must be `VK_STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR`

- `pNext` must be `NULL`

- `fence` must be a valid VkFence handle

- `handleType` must be a valid VkExternalFenceHandleTypeFlagBits value

## See Also

VkExternalFenceHandleTypeFlagBits, VkFence, VkStructureType, vkGetFenceWin32HandleKHR

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