vkRegisterDisplayEventEXT(3)

# vkRegisterDisplayEventEXT(3) Manual Page

## Name

vkRegisterDisplayEventEXT - Signal a fence when a display event occurs

## C Specification

To create a fence that will be signaled when an event occurs on a VkDisplayKHR object, call:

    VkResult vkRegisterDisplayEventEXT(
        VkDevice                                    device,
        VkDisplayKHR                                display,
        const VkDisplayEventInfoEXT*                pDisplayEventInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkFence*                                    pFence);

## Parameters

- `device` is a logical device associated with `display`

- `display` is the display on which the event may occur.

- `pDisplayEventInfo` is a pointer to a VkDisplayEventInfoEXT structure describing the event of interest to the application.

- `pAllocator` controls host memory allocation as described in the Memory Allocation chapter.

- `pFence` is a pointer to a handle in which the resulting fence object is returned.

## Description

Valid Usage (Implicit)

- `device` must be a valid VkDevice handle

- `display` must be a valid VkDisplayKHR handle

- `pDisplayEventInfo` must be a valid pointer to a valid VkDisplayEventInfoEXT structure

- If `pAllocator` is not `NULL`, `pAllocator` must be a valid pointer to a valid VkAllocationCallbacks structure

- `pFence` must be a valid pointer to a VkFence handle

- Both of `device`, and `display` must have been created, allocated, or retrieved from the same VkPhysicalDevice

Return Codes

On success, this command returns

  - `VK_SUCCESS`

## See Also

VkAllocationCallbacks, VkDevice, VkDisplayEventInfoEXT, VkDisplayKHR, VkFence

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