lsfg-vk/framegen/include/vk/core/fence.hpp

#pragma once

#include "vk/core/device.hpp"

#include <vulkan/vulkan_core.h>

#include <cstdint>
#include <memory>

namespace VK::Core {

    ///
    /// C++ wrapper class for a Vulkan fence.
    ///
    /// This class manages the lifetime of a Vulkan fence.
    ///
    class Fence {
    public:
        Fence() noexcept = default;

        ///
        /// Create the fence.
        ///
        /// @param device Vulkan device
        ///
        /// @throws VK::vulkan_error if object creation fails.
        ///
        Fence(const Device& device);

        ///
        /// Reset the fence to an unsignaled state.
        ///
        /// @param device Vulkan device
        ///
        /// @throws VK::vulkan_error if resetting fails.
        ///
        void reset(const Device& device) const;

        ///
        /// Wait for the fence
        ///
        /// @param device Vulkan device
        /// @param timeout The timeout in nanoseconds, or UINT64_MAX for no timeout.
        /// @returns true if the fence signaled, false if it timed out.
        ///
        /// @throws VK::vulkan_error if waiting fails.
        ///
        [[nodiscard]] bool wait(const Device& device, uint64_t timeout = UINT64_MAX) const;

        /// Get the Vulkan handle.
        [[nodiscard]] auto handle() const { return *this->fence; }
    private:
        std::shared_ptr<VkFence> fence;
    };

}