SlateRHIRendererSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "Engine/DeveloperSettings.h"
#include "Misc/EnumRange.h"
#include "UObject/Object.h"
#include "UObject/SoftObjectPath.h"
#include "Rendering/SlateRendererTypes.h"
#include "Templates/SubclassOf.h"
 
#include "SlateRHIRendererSettings.generated.h"
 
#define UE_API SLATERHIRENDERER_API
 
class USlateRHIPostBufferProcessor;
class UTextureRenderTarget2D;
 
UENUM(BlueprintType)
enum class ESlatePostResolution : uint8
{
    Full = 0,
    Half = 1
};
 
USTRUCT(BlueprintType, meta=(HiddenByDefault, DisableSplitPin))
struct FSlatePostSettings
{
    GENERATED_BODY()
 
public:
 
    UE_API FSlatePostSettings();
 
    friend class USlateRHIRendererSettings;
    friend class USlateFXSubsytem;
 
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=BufferSettings, meta=(PinHiddenByDefault))
    uint8 bEnabled:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=BufferSettings)
    ESlatePostResolution Resolution;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = BufferSettings, Meta = (AllowAbstract = false))
    TSubclassOf<USlateRHIPostBufferProcessor> PostProcessorClass;
 
private:
 
    UPROPERTY()
    FString PathToSlatePostRT;
    
public:
 
    const FString& GetPathToSlatePostRT() const { return PathToSlatePostRT; }
 
private:
 
    UPROPERTY(Transient)
    TObjectPtr<UTextureRenderTarget2D> CachedSlatePostRT;
 
    bool bLoadAttempted:1;
};
 
UCLASS(MinimalAPI, config = Game, defaultconfig)
class USlateRHIRendererSettings : public UDeveloperSettings
{
    GENERATED_BODY()
 
public:
    static const USlateRHIRendererSettings* Get()
    {
        if (!IsClassLoaded<USlateRHIRendererSettings>())
        {
            return nullptr;
        }
        return GetDefault<USlateRHIRendererSettings>();
    }
 
    static USlateRHIRendererSettings* GetMutable()
    {
        if (!IsClassLoaded<USlateRHIRendererSettings>())
        {
            return nullptr;
        }
        return GetMutableDefault<USlateRHIRendererSettings>();
    }
 
public:
 
    UE_API USlateRHIRendererSettings();
    UE_API ~USlateRHIRendererSettings();
 
    //~ Begin UObject Interface.
    UE_API virtual void BeginDestroy() override;
    //~ End UObject Interface.
 
public:
 
    UFUNCTION(BlueprintCallable, Category = "SlateFX")
    UE_API FSlatePostSettings& GetMutableSlatePostSetting(ESlatePostRT InPostBufferBit);
 
    UFUNCTION(BlueprintCallable, Category = "SlateFX")
    UE_API const FSlatePostSettings& GetSlatePostSetting(ESlatePostRT InPostBufferBit) const;
 
public:
 
    UE_API UTextureRenderTarget2D* TryGetPostBufferRT(ESlatePostRT InPostBufferBit) const;
 
    UE_API UTextureRenderTarget2D* LoadGetPostBufferRT(ESlatePostRT InPostBufferBit);
 
    UE_API const TMap<ESlatePostRT, FSlatePostSettings>& GetSlatePostSettings() const;
 
    UE_API int32 GetSlatePostBufferDownscaleFactor(ESlatePostRT InPostBufferBit) const;
 
private:
 
    // Map is nice since needs no editor customization. After initial run there should be no more than 5 lookups each frame.
    UPROPERTY(config, EditAnywhere, EditFixedSize, Category = "PostProcessing")
    TMap<ESlatePostRT, FSlatePostSettings> SlatePostSettings;
};
 
#undef UE_API