VKRESETEVENT(3)

NAME
vkResetEvent - Reset an event to non-signaled state.

C SPECIFICATION

    VkResult vkResetEvent(
        VkDevice                                    device,
        VkEvent                                     event);

PARAMETERS

device
    Logical device which owns the event.

event
    A handle to the event object to reset.

DESCRIPTION

vkResetEvent resets the event object specified by event to the non-signaled state.

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

    • event must not be waited on by a vkCmdWaitEvents command that is currently executing

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

vkSetEvent, vkCreateEvent

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.