1. Epic GamesDeveloper
  3. FNiagaraPlatformSet

FNiagaraPlatformSet

API > API/Plugins > API/Plugins/Niagara

   
Name FNiagaraPlatformSet
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraPlatformSet.h
Include Path #include "NiagaraPlatformSet.h"

Syntax

USTRUCT ()  
struct FNiagaraPlatformSet

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraPlatformSet.h  

FNiagaraPlatformSet ( int32 QLMask
)

   NiagaraPlatformSet.h  

Structs

Name Remarks
FCachedCVarInfo Callbacks for any CVars Niagara has looked at during this run.
FPlatformIniSettings Data we pull from platform ini files.

Typedefs

Name Type Remarks Include Path
FOnOverrideActiveDeviceProfile TBaseDelegate_NoParams< TOptional< TObjectPtr< UDeviceProfile > > >   NiagaraPlatformSet.h
FOnOverrideQualityLevel TBaseDelegate_NoParams< int32 >   NiagaraPlatformSet.h

Constants

Name Type Remarks Include Path
CachedAvailableQualityLevelMask int32   NiagaraPlatformSet.h
CachedCVarInfo TMap< FName, FCachedCVarInfo >   NiagaraPlatformSet.h
CachedCVarInfoCritSec FCriticalSection   NiagaraPlatformSet.h
CachedPlatformIniCritSec FCriticalSection   NiagaraPlatformSet.h
CachedPlatformIniSettings TMap< FName, FPlatformIniSettings > Cached data read from platform ini files. NiagaraPlatformSet.h
CachedQLMasksPerDeviceProfile TMap< const UDeviceProfile *, int32 > Cached final QualityLevel setting for each device profile. NiagaraPlatformSet.h
CachedQualityLevel int32 Cached value of the CVar fx.Niagara.QualityLevel. NiagaraPlatformSet.h
ChangedCVars TArray< FName >   NiagaraPlatformSet.h
LastDirtiedFrame uint32 Set from outside when we need to force all cached values to be regenerated. For example on CVar changes. NiagaraPlatformSet.h
QualityLevelOverride int32 An override for Niagara quality level, driven from the Niagara UI. NiagaraPlatformSet.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CVarConditions TArray< FNiagaraPlatformSetCVarCondition > Set of CVars values we require for this platform set to be enabled. NiagaraPlatformSet.h
  • EditAnywhere
  • Category=Platforms
DeviceProfileStates TArray< FNiagaraDeviceProfileStateEntry > States of specific device profiles we've set. NiagaraPlatformSet.h
  • EditAnywhere
  • Category=Platforms
OnOverrideActiveDeviceProfileDelegate FOnOverrideActiveDeviceProfile   NiagaraPlatformSet.h  
OnOverrideQualityLevelDelegate FOnOverrideQualityLevel   NiagaraPlatformSet.h  
QualityLevelMask int32 Mask defining which effects qualities this set matches. NiagaraPlatformSet.h
  • EditAnywhere
  • Category=Platforms

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnabledForCurrentProfileAndEffectQuality uint32   NiagaraPlatformSet.h  
LastBuiltFrame uint32 Last frame we built our cached data. NiagaraPlatformSet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyRedirects()

   NiagaraPlatformSet.h  

bool CanConsiderDeviceProfile ( const UDeviceProfile* Profile
) const

   NiagaraPlatformSet.h  

ENiagaraPlatformSelectionState GetDeviceProfileState ( UDeviceProfile* Profile,
int32 QualityLevel
) const

   NiagaraPlatformSet.h  

int32 GetEnabledMaskForDeviceProfile ( const UDeviceProfile* DeviceProfile
) const

 Is this platform set enabled on any quality level for the passed device profile. NiagaraPlatformSet.h  

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

 Fill OutProfiles with all device profiles that have been overridden at the passed QualityLevel. NiagaraPlatformSet.h  

bool IsActive()

 Is this set active right now. i.e. enabled for the current device profile and quality level. NiagaraPlatformSet.h  

bool IsEffectQualityEnabled ( int32 EffectQuality
) const

 Editor only public API. NiagaraPlatformSet.h  

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

   NiagaraPlatformSet.h  

int32 IsEnabledForDeviceProfile ( const UDeviceProfile* DeviceProfile
) const

 Is this platform set enabled for the give device profile. NiagaraPlatformSet.h  

bool IsEnabledForPlatform ( const FString& PlatformName
) const

 Returns true if this set is enabled for any profiles on the specified platform. NiagaraPlatformSet.h  

bool IsEnabledForQualityLevel ( int32 QualityLevel
) const

 Is this platform set enabled at this quality level on any device profile. NiagaraPlatformSet.h  

void OnChanged()

 Invalidates any cached data on this platform set when something has changed. NiagaraPlatformSet.h  

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

   NiagaraPlatformSet.h  

void SetEnabledForEffectQuality ( int32 EffectQuality,
bool bEnabled
)

   NiagaraPlatformSet.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CanChangeScalabilityAtRuntime ( const UDeviceProfile* DeviceProfile
)

 Returns true if the passed platform can modify it's niagara scalability settings at runtime. NiagaraPlatformSet.h  
Returns true if the current platform can modify it's Niagara scalability settings at runtime. NiagaraPlatformSet.h  

static void ClearNiagaraQualityLevelOverride()

   NiagaraPlatformSet.h  

static int32 CreateQualityLevelMask ( int32 QL
)

   NiagaraPlatformSet.h  

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

 Inspects the passed sets and generates an array of all conflicts between these sets. NiagaraPlatformSet.h  

static int32 GetActiveQualityMaskForDeviceProfile ( const UDeviceProfile* Profile
)

 Returns the currenlty(or default) active quality mask for a profile. NiagaraPlatformSet.h  

static int32 GetAvailableQualityLevelMask()

   NiagaraPlatformSet.h  

static int32 GetAvailableQualityMaskForDeviceProfile ( const UDeviceProfile* Profile
)

 Returns the mask of all available quality levels for a device profile. NiagaraPlatformSet.h  

static IConsoleVariable * GetCVar ( FName CVarName
)

   NiagaraPlatformSet.h  

static int32 GetEffectQualityMaskForPlatform ( const FString& PlatformName
)

   NiagaraPlatformSet.h  

static int32 GetFullQualityLevelMask ( int32 NumQualityLevels
)

   NiagaraPlatformSet.h  

static uint32 GetLastDirtiedFrame()

   NiagaraPlatformSet.h  

static int32 GetMaxQualityLevel()

   NiagaraPlatformSet.h  

static int32 GetMinQualityLevel()

   NiagaraPlatformSet.h  

static FPlatformIniSettings & GetPlatformIniSettings ( const FString& PlatformName
)

   NiagaraPlatformSet.h  

static int32 GetQualityLevel()

   NiagaraPlatformSet.h  

static FText GetQualityLevelMaskText ( int32 QualityLevelMask
)

   NiagaraPlatformSet.h  

static FText GetQualityLevelText ( int32 QualityLevel
)

   NiagaraPlatformSet.h  

static void InvalidateCachedData()

 Will force all platform sets to regenerate their cached data next time they are used. NiagaraPlatformSet.h  

static void OnCVarChanged ( IConsoleVariable* CVar
)

   NiagaraPlatformSet.h  

static void OnCVarUnregistered ( IConsoleVariable* CVar
)

   NiagaraPlatformSet.h  

static int32 QualityLevelFromMask ( int32 QLMask
)

   NiagaraPlatformSet.h  

static void RefreshScalability()

   NiagaraPlatformSet.h  

static void SetNiagaraQualityLevelOverride ( int32 Override
)

   NiagaraPlatformSet.h  

static bool ShouldPruneEmittersOnCook ( const FString& PlatformName
)

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

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FNiagaraPlatformSet& Other
) const

   NiagaraPlatformSet.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page