VKRESETFENCES(3)

NAME
vkResetFences - Resets one or more fence objects.

C SPECIFICATION

To reset the status of one or more fences to the unsignaled state, use the command:

    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 fenceCount fence handles to reset.

DESCRIPTION

If a fence is already in the unsignaled state, then resetting it has no effect.

VALID USAGE

    • 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

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

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.