UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLumenVisualizationData Class Reference

#include <LumenVisualizationData.h>

Classes

struct  FModeRecord
 

Public Types

enum class  FModeType : uint8 { Overview , Standard }
 
typedef TMultiMap< FName, FModeRecordTModeMap
 

Public Member Functions

 FLumenVisualizationData ()
 
void Initialize ()
 
bool IsInitialized () const
 
ENGINE_API bool IsActive () const
 
ENGINE_API FText GetModeDisplayName (const FName &InModeName) const
 
ENGINE_API int32 GetModeID (const FName &InModeName) const
 
ENGINE_API bool GetModeDefaultComposited (const FName &InModeName) const
 
const TModeMapGetModeMap () const
 

Static Public Member Functions

static const TCHARGetVisualizeConsoleCommandName ()
 

Member Typedef Documentation

◆ TModeMap

Mapping of FName to a visualization mode record.

Member Enumeration Documentation

◆ FModeType

Enumerator
Overview 
Standard 

Constructor & Destructor Documentation

◆ FLumenVisualizationData()

FLumenVisualizationData::FLumenVisualizationData ( )
inline

Member Function Documentation

◆ GetModeDefaultComposited()

bool FLumenVisualizationData::GetModeDefaultComposited ( const FName InModeName) const

◆ GetModeDisplayName()

FText FLumenVisualizationData::GetModeDisplayName ( const FName InModeName) const

Get the display name of a named mode from the available mode map.

◆ GetModeID()

int32 FLumenVisualizationData::GetModeID ( const FName InModeName) const

◆ GetModeMap()

const TModeMap & FLumenVisualizationData::GetModeMap ( ) const
inline

◆ GetVisualizeConsoleCommandName()

static const TCHAR * FLumenVisualizationData::GetVisualizeConsoleCommandName ( )
inlinestatic

Return the console command name for enabling single mode visualization.

◆ Initialize()

void FLumenVisualizationData::Initialize ( )

Initialize the system.

◆ IsActive()

ENGINE_API bool FLumenVisualizationData::IsActive ( ) const

Check if visualization is active.

◆ IsInitialized()

bool FLumenVisualizationData::IsInitialized ( ) const
inline

Check if system was initialized.


The documentation for this class was generated from the following files: