Function Prototype

vkGetEventStatus

Retrieve the status of an event object

To query the state of an event from the host, call:

VkResult vkGetEventStatus(
    VkDevice device,
    VkEvent event);
  • device is the logical device that owns the event.
  • event is the handle of the event to query.

Upon success, vkGetEventStatus returns the state of the event object with the following return codes:

Table 1. Event Object Status Codes
StatusMeaning

VK_EVENT_SET

The event specified by event is signaled.

VK_EVENT_RESET

The event specified by event is unsignaled.

If a vkCmdSetEvent or vkCmdResetEvent command is in a command buffer that is in the pending state, then the value returned by this command may immediately be out of date.

The state of an event can be updated by the host. The state of the event is immediately changed, and subsequent calls to vkGetEventStatus will return the new state. If an event is already in the requested state, then updating it to the same state has no effect.

Valid Usage

VUID-vkGetEventStatus-event-03940

event must not have been created with VK_EVENT_CREATE_DEVICE_ONLY_BIT

Valid Usage (Implicit)

VUID-vkGetEventStatus-event-parent

event must have been created, allocated, or retrieved from device