VKRESETEVENT(3)

NAME
vkResetEvent - Reset an event to non-signaled state

C SPECIFICATION

To set the state of an event to unsignaled from the host, call:

    VkResult vkResetEvent(
        VkDevice                                    device,
        VkEvent                                     event);

PARAMETERS

    • device is the logical device that owns the event.

    • event is the event to reset.

DESCRIPTION
Valid Usage

    • event must not be waited on by a vkCmdWaitEvents command that is currently executing
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
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

VkDevice, VkEvent

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.