GPUSkinCacheVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Async/Mutex.h"
 
class FGPUSkinCacheVisualizationData
{
public:
    enum class FModeType : uint8
    {
        Overview,
        Memory,
        RayTracingLODOffset,
        Num
    };
 
    struct FModeRecord
    {
        FString   ModeString;
        FName     ModeName;
        FText     ModeText;
        FText     ModeDesc;
        FModeType ModeType;
    };
 
    typedef TMap<FName, FModeRecord> TModeMap;
 
public:
 
    void Initialize();
 
    inline bool IsInitialized() const { return bIsInitialized.load(std::memory_order_relaxed); }
 
    ENGINE_API bool IsActive() const;
 
    ENGINE_API bool Update(const FName& InViewMode);
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    FModeType GetModeType(const FName& InModeName) const;
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
    inline FModeType GetActiveModeType() const
    {
        return ActiveVisualizationModeType;
    }
 
    inline const FName& GetActiveModeName() const
    {
        return ActiveVisualizationModeName;
    }
 
    static const TCHAR* GetVisualizeConsoleCommandName()
    {
        return TEXT("r.SkinCache.Visualize");
    }
 
private:
    void ConfigureConsoleCommand();
 
    void AddVisualizationMode(
        const TCHAR* ModeString,
        const FText& ModeText,
        const FText& ModeDesc,
        const FModeType ModeType
    );
 
    void SetActiveMode(FModeType ModeType, const FName& ModeName);
 
private:
    UE::FMutex Mutex;
 
    TModeMap ModeMap;
 
    FModeType ActiveVisualizationModeType = FModeType::Num;
    FName ActiveVisualizationModeName = NAME_None;
 
    FString ConsoleDocumentationVisualizationMode;
 
    std::atomic_bool bIsInitialized = { false };
};
 
ENGINE_API FGPUSkinCacheVisualizationData& GetGPUSkinCacheVisualizationData();