1. Epic GamesDeveloper
  3. FNiagaraDebugHUDSettingsData

FNiagaraDebugHUDSettingsData

Settings for Niagara debug HUD.

API > API/Plugins > API/Plugins/Niagara

Settings for Niagara debug HUD. Contained in it's own struct so that we can pass it whole in a message to the debugger client.

   
Name FNiagaraDebugHUDSettingsData
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDebuggerCommon.h
Include Path #include "NiagaraDebuggerCommon.h"

Syntax

USTRUCT ()  
struct FNiagaraDebugHUDSettingsData

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraDebugHUDSettingsData()

   NiagaraDebuggerCommon.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActorFilter FString Wildcard filter which is compared against the Components Actor name to narrow down the detailed information. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(DisplayName="Actor Name Filter", EditCondition="bActorFilterEnabled")
bActorFilterEnabled bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(InlineEditConditionToggle)
bComponentFilterEnabled bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(InlineEditConditionToggle)
bDrawBoundsEnabled bool   NiagaraDebuggerCommon.h  
bDrawBoundsWireframe bool   NiagaraDebuggerCommon.h  
bEmitterFilterEnabled bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(InlineEditConditionToggle)
bEnableGpuParticleReadback bool When enabled GPU particle data will be copied from the GPU to the CPU. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables")
bHudEnabled bool Primary control for all HUD features. NiagaraDebuggerCommon.h  
bHudRenderingEnabled bool Primary control for HUD rendering. NiagaraDebuggerCommon.h  
bIncludeCascade bool When enabled the overview display will include cascade FX. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Overview"
  • AdvancedDisplay
bLoopTimeEnabled bool   NiagaraDebuggerCommon.h  
bOverviewEnabled bool When enabled the overview display will be enabled. NiagaraDebuggerCommon.h  
bOverviewShowFilteredSystemOnly bool When enabled the overview will only show the filter system information. NiagaraDebuggerCommon.h  
bPlaybackRateEnabled bool   NiagaraDebuggerCommon.h  
bShowGlobalBudgetInfo bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Overview"
  • AdvancedDisplay
bShowParticleIndex bool When enabled the particle index will be displayed along with any attributes. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables")
bShowParticlesVariablesWithSystem bool When enabled particle attributes will display with the system information rather than in world at the particle location. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables && SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None", DisplayName="Display With System Attributes")
bShowParticleVariables bool When enabled will show particle attributes from the list. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(DisplayName="Show Particle Attributes")
bShowParticleVariablesVertical bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables", DisplayName="Stack Attributes Vertical")
bShowPerfColumGameThreadOnly bool Adds a column that displays only the GT cost to the perf overview. Only enabled when performance overview mode is active. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance"
  • Meta=(DisplayName="Show separate GT perf column", EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::Performance")
bShowRegisteredComponents bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Overview"
bSystemFilterEnabled bool If enabled, then only systems matching the filters will be considered by the debug hud NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(DisplayName="Filter Displayed Systems")
bSystemShowActiveOnlyInWorld bool When disabled in world rendering will show systems deactivated by scalability. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug System"
  • Meta=(EditCondition="SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None")
bUseMaxParticlesToDisplay bool   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables")
bUseParticleDisplayCenterRadius bool When enabled we use a radius from the display center to avoid showing too many particle attributes. NiagaraDebuggerCommon.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables")
bUseParticleDisplayClip bool When enabled we use the clip planes to narrow down which particles to display NiagaraDebuggerCommon.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables")
bUsePerfGraphTimeRange bool Use the specified user range when enabled, otherwise we will auto detect the range to use. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(DisplayName="Fixed Y Axis Range", EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
bValidateParticleDataBuffers bool When enabled all Niagara systems that pass the filter will have the particle data buffers validation. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Validation"
  • Meta=(EditCondition=bValidationEnabled, EditConditionHides)
bValidateSystemSimulationDataBuffers bool When enabled all Niagara systems that pass the filter will have the simulation data buffers validation. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Validation"
  • Meta=(EditCondition=bValidationEnabled, EditConditionHides)
bValidationEnabled bool Primary control for validation settings. NiagaraDebuggerCommon.h  
bValidationLogErrors bool When enabled all validation errors will be sent to the log as warnings. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Validation"
  • Meta=(EditCondition=bValidationEnabled, EditConditionHides)
bWidgetEnabled bool   NiagaraDebuggerCommon.h
  • Transient
ComponentFilter FString Wildcard filter for the components to show more detailed information about. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(DisplayName="Component Name Filter", EditCondition="bComponentFilterEnabled")
DataInterfaceVerbosity ENiagaraDebugHudVerbosity When enabled allows data interfaces to include additional debugging information. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug System"
  • Meta=(EditCondition="SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None")
DefaultBackgroundColor FLinearColor Default background color used generally for panels. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
DrawBoundsAlpha float   NiagaraDebuggerCommon.h  
EmitterFilter FString Wildcard filter used to match emitters when generating particle attribute view. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(DisplayName="Emitter Name Filter", EditCondition="bEmitterFilterEnabled")
InWorldErrorTextColor FLinearColor In world text if an error is detected. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
InWorldTextColor FLinearColor In world text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
LoopTime float   NiagaraDebuggerCommon.h  
MaxParticlesToDisplay int32 When enabled, the maximum number of particles to show information about. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bUseMaxParticlesToDisplay && bShowParticleVariables", UIMin="1", ClampMin="1")
MessageErrorTextColor FLinearColor Message display error text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
MessageInfoTextColor FLinearColor Message display text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
MessageWarningTextColor FLinearColor Message display warning text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
OverviewDetailColor FLinearColor Overview detail text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
OverviewDetailHighlightColor FLinearColor Overview detail highlight text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
OverviewFont ENiagaraDebugHudFont Overview display font to use. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
  • Meta=(DisplayName="Debug Overview Font", EditCondition="bOverviewEnabled")
OverviewHeadingColor FLinearColor Overview heading text color. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
OverviewLocation FVector2D Overview display location. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
  • Meta=(DisplayName="Debug Overview Text Location", EditCondition="bOverviewEnabled")
OverviewMode ENiagaraDebugHUDOverviewMode   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Overview"
  • Meta=(DisplayName="Debug Overview Mode")
OverviewSortMode ENiagaraDebugHUDDOverviewSort How to sort the displayed list of systems. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Overview"
  • Meta=(DisplayName="Debug Overview Sort Mode")
ParticleDisplayCenterRadius float Radius from screen center where 0 is center to 1.0 is edge to avoid display too many particle attributes. NiagaraDebuggerCommon.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables", UIMin="0", ClampMin="0")
ParticleDisplayClip FVector2D Clipping planes used to display particle attributes. NiagaraDebuggerCommon.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables", UIMin="0", ClampMin="0")
ParticlesVariables TArray< FNiagaraDebugHUDVariable > List of attributes to show per particle, each entry uses wildcard matching. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Particles"
  • Meta=(EditCondition="bShowParticleVariables", DisplayName="Particle Attributes")
ParticleTextOptions FNiagaraDebugHudTextOptions Sets display text options for particle information. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
  • Meta=(EditCondition="bShowParticleVariables")
PerfGraphAxisColor FLinearColor   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
PerfGraphMode ENiagaraDebugHUDPerfGraphMode Time range of the Y Axis of the perf graph NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
PerfGraphSize FVector2D Pixel size of the perf graph. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
PerfGraphTimeRange float Time range of the Y Axis of the perf graph NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(DisplayName="Y Axis Time Range", EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
PerfHistoryFrames int32 How many frames of history to display in the perf graphs. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
PerfReportFrames int32 How many frames to capture in between updates to the max and average perf report values. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance"
PerfSampleMode ENiagaraDebugHUDPerfSampleMode   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance"
PerfUnits ENiagaraDebugHUDPerfUnits   NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance"
PlaybackMode ENiagaraDebugPlaybackMode   NiagaraDebuggerCommon.h  
PlaybackRate float   NiagaraDebuggerCommon.h  
SmoothingWidth int32 Number of samples to use either size of a value when smoothing perf graphs. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Performance Graph"
  • Meta=(EditCondition="OverviewMode == ENiagaraDebugHUDOverviewMode::PerformanceGraph", EditConditionHides)
SystemColorHSVMax FVector Maximum HSV values for the random colors generated for each System. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
SystemColorHSVMin FVector Minimum HSV values for the random colors generated for each System. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
SystemColorSeed uint32 Additional seed value for random system colors. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
SystemColorTableOpacity float Opacity of the system color background tile in overview table rows. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
SystemDebugVerbosity ENiagaraDebugHudVerbosity When enabled system debug information will be displayed in world. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug System"
SystemEmitterVerbosity ENiagaraDebugHudVerbosity When enabled we show information about emitter / particle counts. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug System"
  • Meta=(EditCondition="SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None")
SystemFilter FString Wildcard filter for the systems to show more detailed information about. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Filter"
  • Meta=(DisplayName="System Name Filter", EditCondition="bSystemFilterEnabled")
SystemTextOptions FNiagaraDebugHudTextOptions Sets display text options for system information. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Style"
  • Meta=(EditCondition="SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None")
SystemVariables TArray< FNiagaraDebugHUDVariable > List of attributes to show about the system, each entry uses wildcard matching. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug System"
  • Meta=(EditCondition="SystemDebugVerbosity != ENiagaraDebugHudVerbosity::None", DisplayName="System Attributes")
ValidationAttributeDisplayTruncate int32 When > 0 this is the maximum number of attributes we will display that contain a NaN, there could be more but the display will be truncated to this amount. NiagaraDebuggerCommon.h
  • EditAnywhere
  • Category="Debug Validation"
  • Meta=(EditCondition=bValidationEnabled, EditConditionHides)

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsEnabled()

   NiagaraDebuggerCommon.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page