Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraPlatformSet

Light Theme

Dark Theme

FNiagaraPlatformSet

Windows

MacOS

Linux

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraPlatformSet.h
Include	#include "NiagaraPlatformSet.h"

Syntax

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

Variables

		Name	Description
	TArray< FNiagar...	DeviceProfileStates	States of specific device profiles we've set.
	int32	QualityLevelMask	Mask defining which effects qualities this set matches.

Constructors

	Name	Description
	FNiagaraPlatformSet()
	FNiagaraPlatformSet ( int32 QLMask )

Functions

	Name	Description
bool	CanChangeScalabilityAtRuntime ( const FString& PlatformName )	Returns true if the passed platform can modify it's niagara scalability settings at runtime.
bool	CanChangeScalabilityAtRuntime ( const UDeviceProfile* DevicePr... )	Returns true if the passed platform can modify it's niagara scalability settings at runtime.
bool	CanChangeScalabilityAtRuntime()	Returns true if the current platform can modify it's Niagara scalability settings at runtime.
int32	CreateQualityLevelMask ( int32 QL )
bool	GatherConflicts ( const TArray< const FNiagaraPlatfor..., TArray< FNiagaraPlatformSetConflict... )	Inspects the passed sets and generates an array of all conflicts between these sets.
ENiagaraPlat...	GetDeviceProfileState ( UDeviceProfile* Profile, int32 QualityLevel )
int32	GetEffectQualityMaskForDeviceProfile ( const UDeviceProfile* Profile )
void	GetOverridenDeviceProfiles ( int32 QualityLevel, TArray< UDeviceProfile* >& Ou..., TArray< UDeviceProfile* >& Ou... )	Fill OutProfiles with all device profiles that have been overridden at the passed QualityLevel.
int32	GetQualityLevel()
FText	GetQualityLevelMaskText ( int32 QualityLevelMask )
FText	GetQualityLevelText ( int32 QualityLevel )
void	InvalidateCachedData()	Will force all platform sets to regenerate their cached data next time they are used.
bool	IsActive()	Is this set active right now. i.e. enabled for the current device profile and quality level.
bool	IsEffectQualityEnabled ( int32 EffectQuality )	Editor only public API.
int32	IsEnabledForDeviceProfile ( const UDeviceProfile* DevicePr... )	Is this platform set enabled on any quality level for the passed device profile.
bool	IsEnabledForPlatform ( const FString& PlatformName )	Returns true if this set is enabled for any profiles on the specified platform.
bool	IsEnabledForQualityLevel ( int32 QualityLevel )	Is this platform set enabled at this quality level on any device profile.
void	OnChanged()	Invalidates any cached data on this platform set when something has changed.
void	OnQualityLevelChanged ( IConsoleVariable* Variable )
int32	QualityLevelFromMask ( int32 QLMask )
void	SetDeviceProfileState ( UDeviceProfile* Profile, int32 QualityLevel, ENiagaraPlatformSelectionState NewS... )
void	SetEnabledForEffectQuality ( int32 EffectQuality, bool bEnabled )
bool	ShouldPruneEmittersOnCook ( const FString& PlatformName )	Returns true if the passed platform should prune emitters on cook.

Constants

Name	Description
CachedPlatformIniSettings	Cached data read from platform ini files.
CachedQLMasksPerDeviceProfile	Cached final QualityLevel setting for each device profile.
CachedQualityLevel
LastDirtiedFrame	Set from outside when we need to force all cached values to be regenerated. For example on CVar changes.

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

Take our survey

Dismiss