ISlate3DRenderer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
class FRHICommandListImmediate;
class FRDGBuilder;
class FSlateDrawBuffer;
class FTextureRenderTarget2DResource;
 
class ISlate3DRenderer : public TSharedFromThis<ISlate3DRenderer, ESPMode::ThreadSafe>
{
public:
    virtual ~ISlate3DRenderer() = default;
 
public:
    struct FScopedAcquireDrawBuffer
    {
        FScopedAcquireDrawBuffer(ISlate3DRenderer& InSlateRenderer, bool bInDeferRenderTargetUpdate = false)
            : SlateRenderer(InSlateRenderer)
            , DrawBuffer(InSlateRenderer.AcquireDrawBuffer())
            , bDeferRenderTargetUpdate(bInDeferRenderTargetUpdate)
        {
        }
        ~FScopedAcquireDrawBuffer()
        {
            if (!bDeferRenderTargetUpdate)
            {
                SlateRenderer.ReleaseDrawBuffer(DrawBuffer);
            }
        }
        FScopedAcquireDrawBuffer(const FScopedAcquireDrawBuffer&) = delete;
        FScopedAcquireDrawBuffer& operator=(const FScopedAcquireDrawBuffer&) = delete;
 
        FSlateDrawBuffer& GetDrawBuffer()
        {
            return DrawBuffer;
        }
 
    private:
        ISlate3DRenderer& SlateRenderer;
        FSlateDrawBuffer& DrawBuffer;
        bool bDeferRenderTargetUpdate;
    };
 
    virtual void SetUseGammaCorrection(bool bUseGammaCorrection) = 0;
    virtual void SetApplyColorDeficiencyCorrection(bool bApplyColorCorrection) = 0;
 
    UE_DEPRECATED(5.1, "Use ISlate3DRenderer::AcquireDrawBuffer instead and release the draw buffer.")
    virtual FSlateDrawBuffer& GetDrawBuffer()
    {
        return AcquireDrawBuffer();
    }
 
    virtual FSlateDrawBuffer& AcquireDrawBuffer() = 0;
 
    virtual void ReleaseDrawBuffer(FSlateDrawBuffer& InWindowDrawBuffer) = 0;
 
    virtual void DrawWindow_GameThread(FSlateDrawBuffer& DrawBuffer) = 0;
 
    virtual void DrawWindowToTarget_RenderThread(FRDGBuilder& GraphBuilder, const struct FRenderThreadUpdateContext& Context) = 0;
 
    UE_DEPRECATED(5.5, "Use the RDG version instead.")
    virtual void DrawWindowToTarget_RenderThread(FRHICommandListImmediate& RHICmdList, const struct FRenderThreadUpdateContext& Context) {}
};
 
typedef TSharedPtr<ISlate3DRenderer, ESPMode::ThreadSafe> ISlate3DRendererPtr;