VKSETEVENT(3)

NAME
vkSetEvent - Set an event to signaled state.

C SPECIFICATION

    VkResult vkSetEvent(
        VkDevice                                    device,
        VkEvent                                     event);

PARAMETERS

device
    Logical device which owns the event.

event
    Handle to the event object to signal.

DESCRIPTION

vkSetEvent sets the event object specified by event to signaled state. event must be an event object owned by device. Subsequent calls to vkGetEventStatus on event will return the new status. If any command buffers are currently executing on any queue on device and are waiting on the event specified by event, then they will be unblocked.

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

HOST SYNCHRONIZATION

    • Host access to event must be externally synchronized

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

vkResetEvent, vkGetEventStatus, vkCmdSetEvent, 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.