RayTracingVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
class FRayTracingVisualizationData
{
public:
    enum class FModeType : uint8
    {
        Overview,
        Standard,
        Performance,
        Timing,
        Other,
    };
 
    struct FModeRecord
    {
        FString   ModeString;
        FName     ModeName;
        FText     ModeText;
        FText     ModeDesc;
        FModeType ModeType;
        int32     ModeID;
 
        bool      bTonemapped;
        bool      bHiddenInEditor;
    };
 
    typedef TMultiMap<FName, FModeRecord> TModeMap;
 
public:
    FRayTracingVisualizationData();
 
    ENGINE_API bool HasOverrides() const;
    ENGINE_API FName ApplyOverrides(const FName& InModeName) const;
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    ENGINE_API int32 GetModeID(const FName& InModeName) const;
 
    ENGINE_API bool GetModeTonemapped(const FName& InModeName) const;
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
private:
 
    void AddVisualizationMode(
        const TCHAR* ModeString,
        const FText& ModeText,
        const FModeType ModeType,
        int32 ModeID,
        bool bTonemapped,
        bool bHiddenInEditor = false
    );
 
    void ConfigureConsoleCommand();
 
private:
    TModeMap ModeMap;
    
    FString ConsoleDocumentationVisualizationMode;
};
 
ENGINE_API FRayTracingVisualizationData& GetRayTracingVisualizationData();