Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FVirtualShadowMapVisualizationData |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/VirtualShadowMapVisualizationData.h |
| Include Path | #include "VirtualShadowMapVisualizationData.h" |
Syntax
class FVirtualShadowMapVisualizationData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVirtualShadowMapVisualizationData() |
VirtualShadowMapVisualizationData.h |
Structs
| Name | Remarks |
|---|---|
| FModeRecord | Describes a single available visualization mode. |
Enums
Public
| Name | Remarks |
|---|---|
| FModeType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TModeMap | TMap< FName, FModeRecord > | Mapping of FName to a visualization mode record. | VirtualShadowMapVisualizationData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SelectAdjacentVisualizeLight | int | VirtualShadowMapVisualizationData.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveVisualizationModeID | int32 | VirtualShadowMapVisualizationData.h | ||
| ActiveVisualizationModeName | FName | VirtualShadowMapVisualizationData.h | ||
| bIsInitialized | bool | Flag indicating if system is initialized. | VirtualShadowMapVisualizationData.h | |
| ConsoleDocumentationVisualizationMode | FString | Storage for console variable documentation strings. | VirtualShadowMapVisualizationData.h | |
| ModeMap | TModeMap | The name->mode mapping table | VirtualShadowMapVisualizationData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetActiveModeID() |
VirtualShadowMapVisualizationData.h | ||
const FName & GetActiveModeName() |
VirtualShadowMapVisualizationData.h | ||
| Get the display name of a named mode from the available mode map. | VirtualShadowMapVisualizationData.h | ||
int32 GetModeID
(
const FName& InModeName |
VirtualShadowMapVisualizationData.h | ||
const TModeMap & GetModeMap() |
VirtualShadowMapVisualizationData.h | ||
EViewModeIndex GetViewModeIndexForVisualization
(
const FName& InModeName |
VirtualShadowMapVisualizationData.h | ||
void Initialize() |
Initialize the system. | VirtualShadowMapVisualizationData.h | |
bool IsActive() |
Check if visualization is active. | VirtualShadowMapVisualizationData.h | |
bool IsInitialized() |
Check if system was initialized. | VirtualShadowMapVisualizationData.h | |
bool IsVSMViewMode
(
EViewModeIndex ViewModeIndex |
VirtualShadowMapVisualizationData.h | ||
bool Update
(
const FName& InViewMode |
Update state and check if visualization is active. | VirtualShadowMapVisualizationData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * GetVisualizeConsoleCommandName() |
Return the console command name for enabling single mode visualization. | VirtualShadowMapVisualizationData.h |