VKGETEVENTSTATUS(3)

NAME
vkGetEventStatus - Retrieve the status of an event object.

C SPECIFICATION

    VkResult vkGetEventStatus(
        VkDevice                                    device,
        VkEvent                                     event);

PARAMETERS

device
    Logical device which owns the event.

event
    A handle to the event whose status to retrieve.

DESCRIPTION

vkGetEventStatus retrieves the status of the event object specified in event. Event objects cannot be directly waited for by the host although it is possible to wait within a command buffer for an event to become signaled by calling vkCmdWaitEvents. Events are set from within a command buffer by calling vkCmdSetEvent and may be reset by calling vkCmdResetEvent. On the host, events may be set and reset by calling vkSetEvent and vkResetEvent, respectively.

VALID USAGE

    • device must be a valid VkDevice handle

    • event must be a valid VkEvent handle

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

    • Each of device and event must have been created, allocated or retrieved from the same VkPhysicalDevice

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

vkSetEvent, vkResetEvent, vkCmdSetEvent, vkCmdResetEvent, vkCmdWaitEvents

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.