1. Epic GamesDeveloper
  3. FNiagaraPlatformSet

FNiagaraPlatformSet

Unreal Engine C++ API Reference > Plugins > Niagara

References

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

Syntax

USTRUCT&40;&41;  
struct FNiagaraPlatformSet

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TArray< FNiagaraPlatformSetCVarCondition > CVarConditions Set of CVars values we require for this platform set to be enabled.
Public variable UProperty Category, EditAnywhere TArray< FNiagaraDeviceProfileStateEntry > DeviceProfileStates States of specific device profiles we've set.
Public variable FOnOverrideActiveDeviceProfile OnOverrideActiveDeviceProfileDelegate  
Public variable FOnOverrideQualityLevel OnOverrideQualityLevelDelegate  
Public variable UProperty Category, EditAnywhere int32 QualityLevelMask Mask defining which effects qualities this set matches.

Constructors

  Type Name Description
Public function    
Public function  

FNiagaraPlatformSet ( int32 QLMask
)

  

Functions

  Type Name Description
Public function bool  
Public function Static bool Returns true if the passed platform can modify it's niagara scalability settings at runtime.
Public function Static bool Returns true if the current platform can modify it's Niagara scalability settings at runtime.
Public function Const bool  
Public function Static void  
Public function Static int32

CreateQualityLevelMask ( int32 QL
)

  
Public function Static bool

GatherConflicts ( TConstArrayView< const FNiagaraPlatformSet* > PlatformSets,
TArray< FNiagaraPlatformSetConflictInfo >& OutConflicts
)

 Inspects the passed sets and generates an array of all conflicts between these sets.
Public function Static int32 Returns the currenlty(or default) active quality mask for a profile.
Public function Static int32  
Public function Static int32 Returns the mask of all available quality levels for a device profile.
Public function Static IConsoleVariable *

GetCVar ( FName CVarName
)

  
Public function Const ENiagaraPlatformSelectionState

GetDeviceProfileState ( UDeviceProfile* Profile,
int32 QualityLevel
)

  
Public function Static int32

GetEffectQualityMaskForPlatform ( const FString& PlatformName
)

  
Public function Const int32 Is this platform set enabled on any quality level for the passed device profile.
Public function Static int32

GetFullQualityLevelMask ( int32 NumQualityLevels
)

  
Public function Static uint32  
Public function Static int32  
Public function Static int32  
Public function Const void

GetOverridenDeviceProfiles ( int32 QualityLevel,
TArray< UDeviceProfile* >& OutEnabledProfiles,
TArray< UDeviceProfile* >& OutDisabledProfiles
)

 Fill OutProfiles with all device profiles that have been overridden at the passed QualityLevel.
Public function Static FPlatformIniSettings &

GetPlatformIniSettings ( const FString& PlatformName
)

  
Public function Static int32  
Public function Static FText

GetQualityLevelMaskText ( int32 QualityLevelMask
)

  
Public function Static FText

GetQualityLevelText ( int32 QualityLevel
)

  
Public function Static void Will force all platform sets to regenerate their cached data next time they are used.
Public function Const bool Is this set active right now. i.e. enabled for the current device profile and quality level.
Public function Const bool

IsEffectQualityEnabled ( int32 EffectQuality
)

 Editor only public API.
Public function Const FNiagaraPlatformSetEnabledState

IsEnabled ( const UDeviceProfile* Profile,
int32 QualityLevel,
bool bCheckCurrentStateOnly,
FNiagaraPlatformSetEnabledStateDetails* OutDetails
)

  
Public function Const int32

IsEnabledForDeviceProfile ( const UDeviceProfile* DeviceProfile
)

 Is this platform set enabled for the give device profile.
Public function Const bool

IsEnabledForPlatform ( const FString& PlatformName
)

 Returns true if this set is enabled for any profiles on the specified platform.
Public function Const bool

IsEnabledForQualityLevel ( int32 QualityLevel
)

 Is this platform set enabled at this quality level on any device profile.
Public function void Invalidates any cached data on this platform set when something has changed.
Public function Static void  
Public function Static void  
Public function Static int32

QualityLevelFromMask ( int32 QLMask
)

  
Public function Static void  
Public function void

SetDeviceProfileState ( UDeviceProfile* Profile,
int32 QualityLevel,
ENiagaraPlatformSelectionState NewState
)

  
Public function void

SetEnabledForEffectQuality ( int32 EffectQuality,
bool bEnabled
)

  
Public function Static void

SetNiagaraQualityLevelOverride ( int32 Override
)

  
Public function Static bool

ShouldPruneEmittersOnCook ( const FString& PlatformName
)

 Returns true if the passed platform should prune emitters on cook.

Operators

  Type Name Description
Public function Const bool

operator== ( const FNiagaraPlatformSet& Other
)

  

Classes

  Type Name Description
Public struct FPlatformIniSettings Data we pull from platform ini files.  

Typedefs

Name Description
FOnOverrideActiveDeviceProfile  
FOnOverrideQualityLevel  

Constants

Name Description
CachedAvailableQualityLevelMask  
CachedCVarInfo  
CachedCVarInfoCritSec  
CachedPlatformIniSettings Cached data read from platform ini files.
CachedQLMasksPerDeviceProfile Cached final QualityLevel setting for each device profile.
CachedQualityLevel Cached value of the CVar fx.Niagara.QualityLevel.
ChangedCVars  
LastDirtiedFrame Set from outside when we need to force all cached values to be regenerated. For example on CVar changes.
QualityLevelOverride An override for Niagara quality level, driven from the Niagara UI.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page