VKRESETFENCES(3)

NAME
vkResetFences - Resets one or more fence objects

C SPECIFICATION

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

    VkResult vkResetFences(
        VkDevice                                    device,
        uint32_t                                    fenceCount,
        const VkFence*                              pFences);

PARAMETERS

    • device is the logical device that owns the fences.

    • fenceCount is the number of fences to reset.

    • pFences is a pointer to an array of fence handles to reset.

DESCRIPTION

When vkResetFences is executed on the host, it defines a fence unsignal operation for each fence, which resets the fence to the unsignaled state.

If any member of pFences is already in the unsignaled state when vkResetFences is executed, then vkResetFences has no effect on that fence. Valid Usage

    • Any given element of pFences must not currently be associated with any queue command that has not yet completed execution on that queue
Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • pFences must be a pointer to an array of fenceCount valid VkFence handles

    • fenceCount must be greater than 0

    • Each element of pFences must have been created, allocated, or retrieved from device
Host Synchronization

    • Host access to each member of pFences 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, VkFence

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.