1. Epic GamesDeveloper
  3. FNiagaraDebugHUDSettingsData

FNiagaraDebugHUDSettingsData

Settings for Niagara debug HUD.

API > API/Plugins > API/Plugins/Niagara

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDebuggerCommon.h
Include #include "NiagaraDebuggerCommon.h"

Syntax

USTRUCT&40;&41;  
struct FNiagaraDebugHUDSettingsData

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta Config FString ActorFilter Wildcard filter which is compared against the Components Actor name to narrow down the detailed information.
Public variable UProperty Category, EditAnywhere, Meta Config bool bActorFilterEnabled  
Public variable UProperty Category, EditAnywhere, Meta Config bool bComponentFilterEnabled  
Public variable UProperty Category, EditAnywhere, Meta Config bool bEmitterFilterEnabled  
Public variable UProperty Category, EditAnywhere, Meta Config bool bEnableGpuParticleReadback When enabled GPU particle data will be copied from the GPU to the CPU.
Public variable UProperty Category, EditAnywhere, Meta Config bool bEnableSmoothing True if perf graphs should be smoothed.
Public variable UProperty Category, EditAnywhere, Meta bool bHudEnabled Primary control for all HUD features.
Public variable UProperty Category, EditAnywhere, Meta bool bHudRenderingEnabled Primary control for HUD rendering.
Public variable UProperty Category, EditAnywhere bool bIncludeCascade When enabled the overview display will include cascade FX.
Public variable UProperty Config bool bLoopTimeEnabled  
Public variable UProperty Category, EditAnywhere, Meta bool bOverviewEnabled When enabled the overview display will be enabled.
Public variable UProperty Category, EditAnywhere, Meta bool bOverviewShowFilteredSystemOnly When enabled the overview will only show the filter system information.
Public variable UProperty bool bPlaybackRateEnabled  
Public variable UProperty Category, EditAnywhere Config bool bShowGlobalBudgetInfo  
Public variable UProperty Category, EditAnywhere, Meta Config bool bShowParticleIndex When enabled the particle index will be displayed along with any attributes.
Public variable UProperty Category, EditAnywhere, Meta Config bool bShowParticlesVariablesWithSystem When enabled particle attributes will display with the system information rather than in world at the particle location.
Public variable UProperty Category, EditAnywhere, Meta Config bool bShowParticleVariables When enabled will show particle attributes from the list.
Public variable UProperty Category, EditAnywhere, Meta Config bool bShowParticleVariablesVertical  
Public variable UProperty Category, EditAnywhere, Meta bool bShowRegisteredComponents Overview display font to use.
Public variable UProperty Category, EditAnywhere, Meta Config bool bShowSystemVariables Should we display the system attributes.
Public variable UProperty Category, EditAnywhere, Meta Config bool bSystemFilterEnabled  
Public variable UProperty Category, EditAnywhere, Meta Config bool bSystemShowActiveOnlyInWorld When disabled in world rendering will show systems deactivated by scalability.
Public variable UProperty Category, EditAnywhere Config bool bSystemShowBounds When enabled will show the system bounds for all filtered systems.
Public variable UProperty Category, EditAnywhere, Meta Config bool bUseMaxParticlesToDisplay  
Public variable UProperty Category, EditAnywhere, Meta Config bool bUseParticleDisplayCenterRadius When enabled we use a radius from the display center to avoid showing too many particle attributes.
Public variable UProperty Category, EditAnywhere, Meta Config bool bUseParticleDisplayClip When enabled we use the clip planes to narrow down which particles to display
Public variable UProperty Category, EditAnywhere bool bValidateParticleDataBuffers When enabled all Niagara systems that pass the filter will have the particle data buffers validation.
Public variable UProperty Category, EditAnywhere bool bValidateSystemSimulationDataBuffers When enabled all Niagara systems that pass the filter will have the simulation data buffers validation.
Public variable UProperty Category, EditAnywhere bool bValidationLogErrors When enabled all validation errors will be sent to the log as warnings.
Public variable UProperty Transient bool bWidgetEnabled  
Public variable UProperty Category, EditAnywhere, Meta Config FString ComponentFilter Wildcard filter for the components to show more detailed information about.
Public variable UProperty Category, EditAnywhere, Meta Config ENiagaraDebugHudVerbosity DataInterfaceVerbosity When enabled allows data interfaces to include additional debugging information.
Public variable UProperty Category, EditAnywhere FLinearColor DefaultBackgroundColor Default background color used generally for panels.
Public variable UProperty Category, EditAnywhere, Meta Config FString EmitterFilter Wildcard filter used to match emitters when generating particle attribute view.
Public variable UProperty Category, EditAnywhere FLinearColor InWorldErrorTextColor In world text if an error is detected.
Public variable UProperty Category, EditAnywhere FLinearColor InWorldTextColor In world text color.
Public variable UProperty Config float LoopTime  
Public variable UProperty Category, EditAnywhere, Meta Config int32 MaxParticlesToDisplay When enabled, the maximum number of particles to show information about.
Public variable UProperty Category, EditAnywhere FLinearColor MessageErrorTextColor Message display error text color.
Public variable UProperty Category, EditAnywhere FLinearColor MessageInfoTextColor Message display text color.
Public variable UProperty Category, EditAnywhere FLinearColor MessageWarningTextColor Message display warning text color.
Public variable UProperty Category, EditAnywhere FLinearColor OverviewDetailColor Overview detail text color.
Public variable UProperty Category, EditAnywhere FLinearColor OverviewDetailHighlightColor Overview detail highlight text color.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraDebugHudFont OverviewFont Overview display font to use.
Public variable UProperty Category, EditAnywhere FLinearColor OverviewHeadingColor Overview heading text color.
Public variable UProperty Category, EditAnywhere, Meta FVector2D OverviewLocation Overview display location.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraDebugHUDOverviewMode OverviewMode  
Public variable UProperty Category, EditAnywhere, Meta ENiagaraDebugHUDDOverviewSort OverviewSortMode  
Public variable UProperty Category, EditAnywhere, Meta Config float ParticleDisplayCenterRadius Radius from screen center where 0 is center to 1.0 is edge to avoid display too many particle attributes.
Public variable UProperty Category, EditAnywhere, Meta Config FVector2D ParticleDisplayClip Clipping planes used to display particle attributes.
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FNiagaraDebugHUDVariable > ParticlesVariables List of attributes to show per particle, each entry uses wildcard matching.
Public variable UProperty Category, EditAnywhere, Meta Config FNiagaraDebugHudTextOptions ParticleTextOptions Sets display text options for particle information.
Public variable UProperty Category, EditAnywhere Config FLinearColor PerfGraphAxisColor  
Public variable UProperty Category, EditAnywhere Config ENiagaraDebugHUDPerfGraphMode PerfGraphMode Time range of the Y Axis of the perf graph
Public variable UProperty Category, EditAnywhere Config FVector2D PerfGraphSize Pixel size of the perf graph.
Public variable UProperty Category, EditAnywhere Config float PerfGraphTimeRange Time range of the Y Axis of the perf graph
Public variable UProperty Category, EditAnywhere Config int32 PerfHistoryFrames How many frames of history to display in the perf graphs.
Public variable UProperty Category, EditAnywhere Config int32 PerfReportFrames How many frames to capture in between updates to the max and average perf report values.
Public variable UProperty Category, EditAnywhere Config ENiagaraDebugHUDPerfSampleMode PerfSampleMode  
Public variable UProperty ENiagaraDebugPlaybackMode PlaybackMode  
Public variable UProperty Config float PlaybackRate  
Public variable UProperty Category, EditAnywhere, Meta Config int32 SmoothingWidth Number of samples to use either size of a value when smoothing perf graphs.
Public variable UProperty Category, EditAnywhere, Meta Config float SystemBoundsSolidBoxAlpha When bounds display is enabled allows you to draw a solid box if alpha is > 0.
Public variable UProperty Category, EditAnywhere Config FVector SystemColorHSVMax Maximum HSV values for the random colors generated for each System.
Public variable UProperty Category, EditAnywhere Config FVector SystemColorHSVMin Minimum HSV values for the random colors generated for each System.
Public variable UProperty Category, EditAnywhere Config uint32 SystemColorSeed Additional seed value for random system colors.
Public variable UProperty Category, EditAnywhere Config float SystemColorTableOpacity Opacity of the system color background tile in overview table rows.
Public variable UProperty Category, EditAnywhere Config ENiagaraDebugHudVerbosity SystemDebugVerbosity When enabled system debug information will be displayed in world.
Public variable UProperty Category, EditAnywhere, Meta Config ENiagaraDebugHudVerbosity SystemEmitterVerbosity When enabled we show information about emitter / particle counts.
Public variable UProperty Category, EditAnywhere, Meta Config FString SystemFilter Wildcard filter for the systems to show more detailed information about.
Public variable UProperty Category, EditAnywhere, Meta Config FNiagaraDebugHudTextOptions SystemTextOptions Sets display text options for system information.
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FNiagaraDebugHUDVariable > SystemVariables List of attributes to show about the system, each entry uses wildcard matching.
Public variable UProperty Category, EditAnywhere int32 ValidationAttributeDisplayTruncate 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.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page