FNiagaraSystemScalabilitySettings Struct Reference

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

Public Member Functions
Functions
void	SetbCullByDistance (bool Value)
	Controls whether distance culling is enabled.
void	SetbCullMaxInstanceCount (bool Value)
	Controls whether we should cull systems based on how many instances with the same Effect Type are active.
void	SetbCullPerSystemMaxInstanceCount (bool Value)
	Controls whether we should cull systems based on how many instances of the system are active.
FNiagaraSystemScalabilitySettings &	opAssign (FNiagaraSystemScalabilitySettings Other)

Public Attributes
Scalability
float32	MaxDistance
	Effects of this type are culled beyond this distance.
int	MaxInstances
	Effects of this type will be culled when total active instances using this same EffectType exceeds this number. If the effect type has a significance handler, instances are sorted by their significance and only the N most significant will be kept. The rest are culled. If it does not have a significance handler, instance count culling will be applied at spawn time only. New FX that would exceed the counts are not spawned/activated.
int	MaxSystemInstances
	Effects of this type will be culled when total active instances of the same NiagaraSystem exceeds this number. If the effect type has a significance handler, instances are sorted by their significance and only the N most significant will be kept. The rest are culled. If it does not have a significance handler, instance count culling will be applied at spawn time only. New FX that would exceed the counts are not spawned/activated.
ENiagaraCullProxyMode	CullProxyMode
	Controls what, if any, proxy will be used in place of culled systems.
int	MaxSystemProxies
	Limit on the number of proxies that can be used at once per system. While much cheaper than full FX instances, proxies still incur some cost so must have a limit. When significance information is available using a significance handler, the most significance proxies will be kept up to this limit.
FNiagaraSystemVisibilityCullingSettings	VisibilityCulling
	Settings controlling how systems are culled by visibility.
FNiagaraGlobalBudgetScaling	BudgetScaling
	Settings related to scaling down FX based on the current budget usage.
FNiagaraPlatformSet	Platforms
	The platforms on which these settings are active (unless overridden).

Detailed Description

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

Member Function Documentation

opAssign()

FNiagaraSystemScalabilitySettings & opAssign

(

FNiagaraSystemScalabilitySettings

Other

)

SetbCullByDistance()

void SetbCullByDistance

(

bool

Value

)

Controls whether distance culling is enabled.

SetbCullMaxInstanceCount()

void SetbCullMaxInstanceCount

(

bool

Value

)

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

SetbCullPerSystemMaxInstanceCount()

void SetbCullPerSystemMaxInstanceCount

(

bool

Value

)

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

Member Data Documentation

BudgetScaling

FNiagaraGlobalBudgetScaling BudgetScaling

Settings related to scaling down FX based on the current budget usage.

CullProxyMode

ENiagaraCullProxyMode CullProxyMode

Controls what, if any, proxy will be used in place of culled systems.

MaxDistance

float32 MaxDistance

Effects of this type are culled beyond this distance.

MaxInstances

int MaxInstances

Effects of this type will be culled when total active instances using this same EffectType exceeds this number. If the effect type has a significance handler, instances are sorted by their significance and only the N most significant will be kept. The rest are culled. If it does not have a significance handler, instance count culling will be applied at spawn time only. New FX that would exceed the counts are not spawned/activated.

MaxSystemInstances

int MaxSystemInstances

Effects of this type will be culled when total active instances of the same NiagaraSystem exceeds this number. If the effect type has a significance handler, instances are sorted by their significance and only the N most significant will be kept. The rest are culled. If it does not have a significance handler, instance count culling will be applied at spawn time only. New FX that would exceed the counts are not spawned/activated.

MaxSystemProxies

int MaxSystemProxies

Limit on the number of proxies that can be used at once per system. While much cheaper than full FX instances, proxies still incur some cost so must have a limit. When significance information is available using a significance handler, the most significance proxies will be kept up to this limit.

Platforms

FNiagaraPlatformSet Platforms

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

VisibilityCulling

FNiagaraSystemVisibilityCullingSettings VisibilityCulling

Settings controlling how systems are culled by visibility.