VKRESETFENCES(3)

NAME
vkResetFences - Resets one or more fence objects.

C SPECIFICATION

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

PARAMETERS

device
    Logical device which owns the specified fences.

fenceCount
    Number of fences specified under pFences.

pFences
    Fences to reset.

DESCRIPTION

vkResetFences resets the status of the fenceCount fences whose handles are passed in the pFences array to unsignaled.

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

    • Each of device and the elements of pFences must have been created, allocated or retrieved from the same VkPhysicalDevice

    • 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

vkCreateFence, vkDestroyFence, vkGetFenceStatus, vkWaitForFences

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.