// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/

vkGetEventStatus(3)
===================

Name
----
vkGetEventStatus - Retrieve the status of an event object.

C Specification
---------------

// refBegin vkGetEventStatus Retrieve the status of an event object.

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

include::../protos/vkGetEventStatus.txt[]


Parameters
----------

  * pname:device is the logical device that owns the event.
  * pname:event is the handle of the event to query.


Description
-----------

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

[width="80%",options="header"]
|=====
| Status | Meaning
| ename:VK_EVENT_SET | The event specified by pname:event is signaled.
| ename:VK_EVENT_RESET | The event specified by pname:event is unsignaled.
|=====

The state of an event can: be updated by the host. The state of the event is
immediately changed, and subsequent calls to fname: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.

include::../validity/protos/vkGetEventStatus.txt[]


See Also
--------

slink:VkDevice, slink:VkEvent


Document Notes
--------------

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkGetEventStatus

This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.

include::footer.txt[]