VulkanViewport.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    VulkanViewport.h: Vulkan viewport RHI definitions.
=============================================================================*/
 
#pragma once
 
#include "VulkanResources.h"
#include "HAL/CriticalSection.h"
 
class FVulkanDynamicRHI;
class FVulkanSwapChain;
class FVulkanQueue;
class FVulkanViewport;
class FVulkanSemaphore;
 
namespace VulkanRHI
{
    class FSemaphore;
}
 
class FVulkanBackBuffer : public FVulkanTexture
{
public:
    FVulkanBackBuffer(FVulkanDevice& Device, FVulkanViewport* InViewport, EPixelFormat Format, uint32 SizeX, uint32 SizeY, ETextureCreateFlags UEFlags);
    virtual ~FVulkanBackBuffer();
    
    void OnGetBackBufferImage(FRHICommandListImmediate& RHICmdList);
    void OnAdvanceBackBufferFrame(FRHICommandListImmediate& RHICmdList);
 
    void ReleaseViewport();
    void ReleaseAcquiredImage();
 
private:
    void AcquireBackBufferImage(FVulkanCommandListContext& Context);
 
private:
    FVulkanViewport* Viewport;
};
 
 
class FVulkanViewport : public FRHIViewport
{
public:
    enum { NUM_BUFFERS = 3 };
 
    FVulkanViewport(FVulkanDevice& InDevice, void* InWindowHandle, uint32 InSizeX,uint32 InSizeY,bool bInIsFullscreen, EPixelFormat InPreferredPixelFormat);
    ~FVulkanViewport();
 
    FTextureRHIRef GetBackBuffer(FRHICommandListImmediate& RHICmdList);
    void AdvanceBackBufferFrame(FRHICommandListImmediate& RHICmdList);
 
    virtual void WaitForFrameEventCompletion() override;
 
    virtual void IssueFrameEvent() override;
 
    inline FIntPoint GetSizeXY() const
    {
        return FIntPoint(SizeX, SizeY);
    }
 
    virtual void SetCustomPresent(FRHICustomPresent* InCustomPresent) override final
    {
        CustomPresent = InCustomPresent;
    }
 
    virtual FRHICustomPresent* GetCustomPresent() const override final
    {
        return CustomPresent;
    }
 
    virtual void Tick(float DeltaTime) override final;
    
    bool Present(FVulkanCommandListContext& Context, bool bLockToVsync);
 
    inline uint32 GetPresentCount() const
    {
        return PresentCount;
    }
 
    inline bool IsFullscreen() const
    {
        return bIsFullscreen;
    }
 
    inline uint32 GetBackBufferImageCount()
    {
        return (uint32)BackBufferImages.Num();
    }
 
    inline VkImage GetBackBufferImage(uint32 Index)
    {
        if (BackBufferImages.Num() > 0)
        {
            return BackBufferImages[Index]->Image;
        }
        else
        {
            return VK_NULL_HANDLE;
        }
    }
 
    inline FVulkanSwapChain* GetSwapChain()
    {
        return SwapChain;
    }
 
    inline void* GetWindowHandle() { return WindowHandle; }
 
    void DestroySwapchain(struct FVulkanSwapChainRecreateInfo* RecreateInfo);
    void RecreateSwapchain(FVulkanCommandListContext& Context, FVulkanPlatformWindowContext& WindowContext);
 
protected:
    FVulkanDevice& Device;
 
    // NUM_BUFFERS don't have to match exactly as the driver can require a minimum number larger than NUM_BUFFERS. Provide some slack
    TArray<TRefCountPtr<FVulkanTexture>, TInlineAllocator<NUM_BUFFERS*2>> BackBufferImages;
    TArray<FVulkanSemaphore*, TInlineAllocator<NUM_BUFFERS*2>> RenderingDoneSemaphores;
    TIndirectArray<FVulkanView, TInlineAllocator<NUM_BUFFERS*2>> TextureViews;
    TRefCountPtr<FVulkanBackBuffer> RHIBackBuffer;
 
    // 'Dummy' back buffer
    TRefCountPtr<FVulkanTexture>    RenderingBackBuffer;
    
    FCriticalSection RecreatingSwapchain;
 
    uint32 SizeX;
    uint32 SizeY;
    bool bIsFullscreen;
    EPixelFormat PixelFormat;
    int32 AcquiredImageIndex;
    FVulkanSwapChain* SwapChain;
    void* WindowHandle;
    uint32 PresentCount;
    bool bRenderOffscreen;
 
    int8 LockToVsync;
 
    // Just a pointer, not owned by this class
    FVulkanSemaphore* AcquiredSemaphore;
 
    FCustomPresentRHIRef CustomPresent;
 
    FVulkanSyncPointRef LastFrameSyncPoint;
 
    EDeviceScreenOrientation CachedOrientation = EDeviceScreenOrientation::Unknown;
    void OnSystemResolutionChanged(uint32 ResX, uint32 ResY);
 
    void CreateSwapchain(FVulkanCommandListContext& Context, struct FVulkanSwapChainRecreateInfo* RecreateInfo, FVulkanPlatformWindowContext& WindowContext);
    bool TryAcquireImageIndex();
    void InitImages(FVulkanContextCommon& Context, TConstArrayView<VkImage> Images);
 
    void RecreateSwapchainFromRT(FRHICommandListImmediate& RHICmdList, EPixelFormat PreferredPixelFormat, FVulkanPlatformWindowContext& WindowContext);
    void RecreateSwapchainFromRT(FRHICommandListImmediate& RHICmdList, FVulkanPlatformWindowContext& WindowContext)
    {
        RecreateSwapchainFromRT(RHICmdList, PixelFormat, WindowContext);
    }
    void Resize(FRHICommandListImmediate& RHICmdList, uint32 InSizeX, uint32 InSizeY, bool bIsFullscreen, EPixelFormat PreferredPixelFormat, FVulkanPlatformWindowContext& WindowContext);
 
    bool DoCheckedSwapChainJob(FVulkanCommandListContext& Context);
    bool SupportsStandardSwapchain();
    bool RequiresRenderingBackBuffer();
    EPixelFormat GetPixelFormatForNonDefaultSwapchain();
 
    friend class FVulkanDynamicRHI;
    friend class FVulkanCommandListContext;
    friend struct FRHICommandAcquireBackBuffer;
    friend class FVulkanBackBuffer;
};
 
template<>
struct TVulkanResourceTraits<FRHIViewport>
{
    typedef FVulkanViewport TConcreteType;
};