FNiagaraDebugHUDSettingsData

Settings for Niagara debug HUD.

Windows
MacOS
Linux

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDebuggerCommon.h

Include

#include "NiagaraDebuggerCommon.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
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

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

bool

 

bEnabled

Master control for all HUD features.

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 Config

bool

 

bLoopTimeEnabled

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bOverviewEnabled

When enabled the overview display will be enabled.

Public variable UProperty

bool

 

bPlaybackRateEnabled

Public variable UProperty Category, EditAnywhere Config

bool

 

bShowGlobalBudgetInfo

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

 

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

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, Meta Config

FString

 

ComponentFilter

Wildcard filter for the components to show more detailed information about.

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

EmitterFilter

Wildcard filter used to match emitters when generating particle attribute view.

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, Meta

ENiagaraDebugHu...

 

OverviewFont

Overview display font to use.

Public variable UProperty Category, EditAnywhere, Meta

FVector2D

 

OverviewLocation

Overview display location.

Public variable UProperty Category, EditAnywhere, Meta Config

TArray< FNiagar...

 

ParticlesVariables

List of attributes to show per particle, each entry uses wildcard matching.

Public variable UProperty Category, EditAnywhere, Meta Config

FNiagaraDebugHu...

 

ParticleTextOptions

Sets display text options for particle information.

Public variable UProperty

ENiagaraDebugPl...

 

PlaybackMode

Public variable UProperty Config

float

 

PlaybackRate

Public variable UProperty Category, EditAnywhere Config

ENiagaraDebugHu...

 

SystemDebugVerbosity

When enabled system debug information will be displayed in world.

Public variable UProperty Category, EditAnywhere, Meta Config

ENiagaraDebugHu...

 

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

FNiagaraDebugHu...

 

SystemTextOptions

Sets display text options for system information.

Public variable UProperty Category, EditAnywhere, Meta Config

TArray< FNiagar...

 

SystemVariables

List of attributes to show about the system, each entry uses wildcard matching.

Constructors

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss