Swapchain.hpp

Go to the documentation of this file.

#pragma once
#include "Common.hpp"
namespace Foundation::RHI {
    class RHIDevice;
    class RHITexture;
    class RHIDeviceSemaphore;
    class RHIDeviceFence;
    class RHISurface;
    enum class RHISwapchainResult {
        Success,
        NotReady,
        Timeout,
        Suboptimal,
        OutOfDate,
        SurfaceLost,
        DeviceLost,
        Error
    };
    // Presentable image was acquired/presented; Suboptimal still warrants recreate when convenient.
    [[nodiscard]] inline bool RHISwapchainResultMayPresent(RHISwapchainResult result)
    {
        return result == RHISwapchainResult::Success || result == RHISwapchainResult::Suboptimal;
    }
    enum class RHISwapchainPresentMode {
        // V-Sync
        Fifo,
        // N buffering
        Mailbox,
        // No V-Sync (tearing allowed)
        Tearing
    };
    class RHISwapchain : public RHIObject {
    protected:
        const RHIDevice& mDevice;
    public:
        struct SwapchainDesc {
            // Name for the swap chain, used for debugging purposes.
            RHIResourceFormat format;
            RHIColorSpace colorSpace;
            // Swapchain buffer sizes.
            RHIExtent2D extents;
            // Min number of buffers in the swap chain. i.e. double buffering = 2, triple buffering = 3, etc.
            // Driver may create more buffers than requested.
            uint32_t minBufferCount;
            // Present mode for the swap chain.
            RHISwapchainPresentMode presentMode;
            // The surface to present to.
            RHIDeviceHandle<RHISurface> surface;
        } mDesc;
        [[nodiscard]] virtual Span<RHITexture* const> GetImages() const = 0;
        RHISwapchain(RHIDevice const& device, SwapchainDesc const& desc) : mDevice(device), mDesc(desc) {}
        virtual RHISwapchainResult GetNextImage(
            uint64_t timeout_ns,
            RHIDeviceHandle<RHIDeviceSemaphore> semaphore,
            RHIDeviceHandle<RHIDeviceFence> fence,
            uint32_t& imageIndex
        ) = 0;            
        [[nodiscard]] virtual RHIExtent2D GetExtents() const = 0;
        [[nodiscard]] float GetAspectRatio() const {
            auto xy = GetExtents();
            return static_cast<float>(xy.x) / static_cast<float>(xy.y);
        }
 
        virtual void DebugSetObjectName(const char* name) = 0;
    };
    ENUM_NAME_CONV_BEGIN(RHISwapchainPresentMode)
        ENUM_NAME(Fifo)
        ENUM_NAME(Mailbox)
        ENUM_NAME(Tearing)
    ENUM_NAME_CONV_END()
}