Function Prototype

vkRegisterDisplayEventEXT

Signal a fence when a display event occurs

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);
  • 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.

Valid Usage (Implicit)

VUID-vkRegisterDisplayEventEXT-pDisplayEventInfo-parameter

pDisplayEventInfo must be a valid pointer to a valid VkDisplayEventInfoEXT structure

VUID-vkRegisterDisplayEventEXT-pAllocator-parameter

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

VUID-vkRegisterDisplayEventEXT-pFence-parameter

pFence must be a valid pointer to a VkFence handle

VUID-vkRegisterDisplayEventEXT-commonparent

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