vkResetEvent(3)

# vkResetEvent(3) Manual Page

## Name

vkResetEvent - Reset an event to non-signaled state

Loading… please wait.

## C Specification

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

    // Provided by VK_VERSION_1_0
    VkResult vkResetEvent(
        VkDevice                                    device,
        VkEvent                                     event);

## Parameters

- `device` is the logical device that owns the event.

- `event` is the event to reset.

## Description

When vkResetEvent is executed on the host, it defines an event unsignal operation which resets the event to the unsignaled state.

If `event` is already in the unsignaled state when vkResetEvent is executed, then vkResetEvent has no effect, and no event unsignal operation occurs.

Valid Usage

- VUID-vkResetEvent-event-01148
  `event` must not be waited on by a `vkCmdWaitEvents` command that is currently executing

Valid Usage (Implicit)

- VUID-vkResetEvent-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkResetEvent-event-parameter
  `event` must be a valid VkEvent handle

- VUID-vkResetEvent-event-parent
  `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_DEVICE_MEMORY`

## See Also

VkDevice, VkEvent

## Document Notes

For more information, see the Vulkan Specification

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

## Copyright

Copyright (c) 2014-2020 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0