vkGetEventStatus(3)

# vkGetEventStatus(3) Manual Page

## Name

vkGetEventStatus - Retrieve the status of an event object

Loading… please wait.

## C Specification

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

    // Provided by VK_VERSION_1_0
    VkResult vkGetEventStatus(
        VkDevice                                    device,
        VkEvent                                     event);

## Parameters

- `device` is the logical device that owns the event.

- `event` is the handle of the event to query.

## Description

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

Table 1. Event Object Status Codes
Status | Meaning
--- | ---
`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 (Implicit)

- `device` must be a valid VkDevice handle

- `event` must be a valid VkEvent handle

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

Return Codes

On success, this command returns

  - `VK_EVENT_SET`

  - `VK_EVENT_RESET`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

  - `VK_ERROR_DEVICE_LOST`

## See Also

VkDevice, VkEvent

## 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 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0