Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FBufferVisualizationData |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/BufferVisualizationData.h |
| Include Path | #include "BufferVisualizationData.h" |
Syntax
class FBufferVisualizationData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBufferVisualizationData() |
BufferVisualizationData.h |
Structs
| Name | Remarks |
|---|---|
| Record | Describes a single available visualization material |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TMaterialMap | TMultiMap< FName, Record > | Mapping of FName (first parameter in ini file material list) to a material record | BufferVisualizationData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | bool | Flag indicating if system is initialized | BufferVisualizationData.h | |
| ConsoleDocumentationOverviewTargets | FString | BufferVisualizationData.h | ||
| ConsoleDocumentationVisualizationMode | FString | Storage for console variable documentation strings | BufferVisualizationData.h | |
| CurrentOverviewMaterialNames | FString | List of material names to use in the buffer visualization overview | BufferVisualizationData.h | |
| MaterialMap | TMaterialMap | The name->material mapping table | BufferVisualizationData.h | |
| MaterialMapFromMaterialName | TMaterialMap | The UMaterial.name->material mapping table | BufferVisualizationData.h | |
| OverviewMaterials | TArray< UMaterialInterface * > | List of material currently in use by the buffer visualization overview | BufferVisualizationData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMaterialInterface * GetMaterial
(
FName InMaterialName |
Get a named material from the available material map | BufferVisualizationData.h | |
bool GetMaterialApplyAutoExposure
(
FName InMaterialName |
Get whether auto exposure should be applied for the visualization mode | BufferVisualizationData.h | |
| Get the display name of a named material from the available material map | BufferVisualizationData.h | ||
TArray< UMaterialInterface * > & GetOverviewMaterials() |
Access the list of materials currently in use by the buffer visualization overview | BufferVisualizationData.h | |
void Initialize() |
Initialise the system | BufferVisualizationData.h | |
bool IsDifferentToCurrentOverviewMaterialNames
(
const FString& InNameList |
BufferVisualizationData.h | ||
bool IsInitialized() |
Check if system was initialized | BufferVisualizationData.h | |
void IterateOverAvailableMaterials
(
T& Iterator |
Iterator function for iterating over available materials | BufferVisualizationData.h | |
void SetCurrentOverviewMaterialNames
(
const FString& InNameList |
We cache the overview material name list from the console command here, so all dynamically created views can re-use the existing cached list of materials | BufferVisualizationData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FText GetMaterialDefaultDisplayName() |
Get the default display name if no material is used and the Overview window is being used | BufferVisualizationData.h | |
static const TCHAR * GetVisualizationTargetConsoleCommandName() |
Return the console command name for enabling single buffer visualization | BufferVisualizationData.h |