FNiagaraSystemScalabilitySettings

Scalability settings for Niagara Systems for a particular platform set (unless overridden).

Windows
MacOS
Linux

Inheritance Hierarchy

FNiagaraSystemScalabilitySettings

FNiagaraSystemScalabilityOverride

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEffectType.h

Include

#include "NiagaraEffectType.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNiagaraSystemScalabilitySettings

Remarks

Scalability settings for Niagara Systems for a particular platform set (unless overridden).

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta

uint32: 1

 

bCullByDistance

Controls whether distance culling is enabled.

Public variable UProperty Category, EditAnywhere, Meta

uint32: 1

 

bCullByGlobalBudget

Controls whether global budget based culling is enabled.

Public variable UProperty Category, EditAnywhere, Meta

uint32: 1

 

bCullByMaxTimeWithoutRender

Controls whether visibility culling is enabled.

Public variable UProperty Category, EditAnywhere, Meta displayname

uint32: 1

 

bCullMaxInstanceCount

Controls whether we should cull systems based on how many instances with the same Effect Type are active.

Public variable UProperty Category, EditAnywhere, Meta displayname

uint32: 1

 

bCullPerSystemMaxInstanceCount

Controls whether we should cull systems based on how many instances of the system are active.

Public variable UProperty Category, EditAnywhere, Meta

float

 

MaxDistance

Effects of this type are culled beyond this distance.

Public variable UProperty Category, EditAnywhere, Meta

float

 

MaxGlobalBudgetUsage

Effects will be culled if the global budget usage exceeds this fraction.

Public variable UProperty Category, EditAnywhere, Meta displayname

int32

 

MaxInstances

Effects of this type will be culled when total active instances using this same EffectType exceeds this number.

Public variable UProperty Category, EditAnywhere, Meta

int32

 

MaxSystemInstances

Effects of this type will be culled when total active instances of the same NiagaraSystem exceeds this number.

Public variable UProperty Category, EditAnywhere, Meta

float

 

MaxTimeWithoutRender

TODO:

Public variable UProperty Category, EditAnywhere

FNiagaraPlatfor...

 

Platforms

The platforms on which these settings are active (unless overridden).

Constructors

Functions

Name Description

Public function

void

 

Clear()

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