SlateRHIRenderer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Textures/SlateShaderResource.h"
#include "Rendering/DrawElements.h"
#include "RHI.h"
#include "RenderCommandFence.h"
#include "RenderResource.h"
#include "SlateRHIResourceManager.h"
#include "UnrealClient.h"
#include "Rendering/SlateRenderer.h"
#include "Rendering/SlateDrawBuffer.h"
#include "Slate/SlateTextures.h"
#include "RendererInterface.h"
 
class FSlateElementBatcher;
class FSlateRHIRenderingPolicy;
class FSlateRHIRenderingPolicyInterface;
class FSlateRHIPostBufferProcessorProxy;
class USlateRHIPostBufferProcessor;
class USlateRHIRendererSettings;
class ISlateStyle;
class SWindow;
struct FSlatePostSettings;
struct FSlateDrawWindowsCommand;
 
extern FMatrix CreateSlateProjectionMatrix(uint32 Width, uint32 Height);
 
// Number of draw buffers that can be active at any given time
const uint32 NumDrawBuffers = 3;
 
// Enable to visualize overdraw in Slate
#define WITH_SLATE_VISUALIZERS !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
 
struct FFastPathRenderingDataCleanUpList;
 
struct FSlateDrawWindowPassInputs;
struct FSlateDrawWindowPassOutputs;
struct FSlateViewportInfo;
struct FSlatePostProcessUpdateRequest;
 
class FSlateRHIRenderer final : public FSlateRenderer
{
public:
    FSlateRHIRenderer( TSharedRef<FSlateFontServices> InSlateFontServices, TSharedRef<FSlateRHIResourceManager> InResourceManager );
 
    virtual bool Initialize() override;
    virtual void Destroy() override;
    virtual FSlateDrawBuffer& AcquireDrawBuffer() override;
    virtual void ReleaseDrawBuffer(FSlateDrawBuffer& InWindowDrawBuffer) override;
    virtual void OnWindowDestroyed( const TSharedRef<SWindow>& InWindow ) override;
    virtual void OnWindowFinishReshaped(const TSharedPtr<SWindow>& InWindow) override;
    virtual void RequestResize( const TSharedPtr<SWindow>& Window, uint32 NewWidth, uint32 NewHeight ) override;
    virtual void CreateViewport( const TSharedRef<SWindow> Window ) override;
    virtual void UpdateFullscreenState( const TSharedRef<SWindow> Window, uint32 OverrideResX, uint32 OverrideResY ) override;
    virtual void SetSystemResolution(uint32 Width, uint32 Height) override;
    virtual void RestoreSystemResolution(const TSharedRef<SWindow> InWindow) override;
    virtual void DrawWindows( FSlateDrawBuffer& InWindowDrawBuffer ) override;
    virtual void FlushCommands() const override;
    virtual void Sync() const override;
    virtual void ReleaseDynamicResource( const FSlateBrush& InBrush ) override;
    virtual void RemoveDynamicBrushResource( TSharedPtr<FSlateDynamicImageBrush> BrushToRemove ) override;
    virtual FIntPoint GenerateDynamicImageResource(const FName InTextureName) override;
    virtual bool GenerateDynamicImageResource( FName ResourceName, uint32 Width, uint32 Height, const TArray< uint8 >& Bytes ) override;
    virtual bool GenerateDynamicImageResource( FName ResourceName, FSlateTextureDataRef TextureData ) override;
    virtual FSlateResourceHandle GetResourceHandle(const FSlateBrush& Brush, FVector2f LocalSize, float DrawScale) override;
    virtual bool CanRenderResource(UObject& InResourceObject) const override;
    virtual void* GetViewportResource( const SWindow& Window ) override;
    virtual void SetColorVisionDeficiencyType(EColorVisionDeficiency Type, int32 Severity, bool bCorrectDeficiency, bool bShowCorrectionWithDeficiency) override;
    virtual FSlateUpdatableTexture* CreateUpdatableTexture(uint32 Width, uint32 Height) override;
    virtual FSlateUpdatableTexture* CreateSharedHandleTexture(void* SharedHandle) override;
    virtual void ReleaseUpdatableTexture(FSlateUpdatableTexture* Texture) override;
    virtual ISlateAtlasProvider* GetTextureAtlasProvider() override;
    virtual FCriticalSection* GetResourceCriticalSection() override;
    virtual void ReleaseAccessedResources(bool bImmediatelyFlush) override;
    virtual int32 RegisterCurrentScene(FSceneInterface* Scene) override;
    virtual int32 GetCurrentSceneIndex() const override;
    virtual void SetCurrentSceneIndex(int32 InIndex) override;
    virtual void ClearScenes() override;
    EPixelFormat GetSlateRecommendedColorFormat() override;
    virtual void DestroyCachedFastPathRenderingData(struct FSlateCachedFastPathRenderingData* InRenderingData) override;
    virtual void DestroyCachedFastPathElementData(FSlateCachedElementData* InCachedElementData) override;
    virtual void BeginFrame() const override;
    virtual void EndFrame() const override;
    virtual void AddWidgetRendererUpdate(const struct FRenderThreadUpdateContext& Context, bool bDeferredRenderTargetUpdate) override;
 
    virtual void ReloadTextureResources() override;
 
    virtual void LoadStyleResources( const ISlateStyle& Style ) override;
 
    virtual bool AreShadersInitialized() const override;
 
    virtual void InvalidateAllViewports() override;
 
    virtual void PrepareToTakeScreenshot(const FIntRect& Rect, TArray<FColor>* OutColorData, SWindow* ScreenshotWindow) override;
    virtual void PrepareToTakeHDRScreenshot(const FIntRect& Rect, TArray<FLinearColor>* OutColorData, SWindow* ScreenshotWindow) override;
 
private:
    FSlateDrawWindowPassOutputs DrawWindow_RenderThread(FRDGBuilder& GraphBuilder, const FSlateDrawWindowPassInputs& Inputs);
 
    void PresentWindow_RenderThread(FRHICommandListImmediate& RHICmdList, const FSlateDrawWindowPassInputs& DrawPassInputs, const FSlateDrawWindowPassOutputs& DrawPassOutputs);
 
    void DrawWindows_RenderThread(FRHICommandListImmediate& RHICmdList, TConstArrayView<FSlateDrawWindowPassInputs> Windows, TConstArrayView<FRenderThreadUpdateContext> DeferredUpdates);
 
    void LoadUsedTextures();
 
    void ResizeViewportIfNeeded(FSlateViewportInfo* ViewportInfo, FIntPoint ExtentToResizeTo, bool bFullscreen, SWindow* Window);
 
    EPixelFormat GetViewportPixelFormat(const SWindow& Window, bool bDisplayFormatIsHDR);
 
    void DrawWindows_Private(FSlateDrawBuffer& InWindowDrawBuffer);
 
    void CleanUpdatableTextures();
 
    void OnVirtualDesktopSizeChanged(const FDisplayMetrics& NewDisplayMetric);
 
    TMap<const SWindow*, FSlateViewportInfo*> WindowToViewportInfo;
 
    FSlateDrawBuffer* EnqueuedWindowDrawBuffer = nullptr;
 
    FSlateDrawBuffer DrawBuffers[NumDrawBuffers];
 
    uint8 FreeBufferIndex = 0;
 
    TUniquePtr<FSlateElementBatcher> ElementBatcher;
 
    TSharedPtr<FSlateRHIResourceManager> ResourceManager;
 
    TSharedPtr<FSlateRHIRenderingPolicy> RenderingPolicy;
 
    TArray<TSharedPtr<FSlateDynamicImageBrush>> DynamicBrushesToRemove[NumDrawBuffers];
 
    struct
    {
        TArray<FSlateCachedFastPathRenderingData*, FConcurrentLinearArrayAllocator> CachedFastPathRenderingData;
        TArray<FSlateCachedElementData*, FConcurrentLinearArrayAllocator> CachedElementData;
 
        bool IsEmpty() const { return CachedFastPathRenderingData.IsEmpty() && CachedElementData.IsEmpty(); }
 
    } PendingDeletes;
 
    void FlushPendingDeletes();
 
    TArray<FRenderThreadUpdateContext, FConcurrentLinearArrayAllocator> DeferredUpdateContexts;
 
    bool bIsStandaloneStereoOnlyDevice = false;
    bool bUpdateHDRDisplayInformation = false;
    ESlatePostRT bShrinkPostBufferRequested = ESlatePostRT::None;
    uint64 LastFramesPostBufferUsed[(uint8)ESlatePostRT::Num];
    FRenderCommandFence SlatePostRTFences[(uint8)ESlatePostRT::Num];
 
    struct
    {
        TStaticArray<uint64, (int32)ESlatePostRT::Num> LastUsedFrameCounter{ InPlace, 0 };
    
    } PostProcessRenderTargets;
 
    struct
    {
        FIntRect ViewRect;
        FSlateViewportInfo* ViewportToCapture = nullptr;
        TArray<FColor>* ColorData = nullptr;
        TArray<FLinearColor>* ColorDataHDR = nullptr;
 
    } ScreenshotState;
 
    TArray<FSceneInterface*, TInlineAllocator<4>> ActiveScenes;
    int32 CurrentSceneIndex = -1;
    
    uint32 ResourceVersion = 0;
};