1. Epic GamesDeveloper
  3. UNiagaraRendererProperties

UNiagaraRendererProperties

Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored on [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) (on the System) for serialization and handed back to the System renderer on load.

API > API/Plugins > API/Plugins/Niagara

Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored on UNiagaraEmitter (on the System) for serialization and handed back to the System renderer on load.

   
Name UNiagaraRendererProperties
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraRendererProperties.h
Include Path #include "NiagaraRendererProperties.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UNiagaraRendererProperties : public UNiagaraMergeable

Inheritance Hierarchy

Derived Classes

UNiagaraRendererProperties derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraRendererProperties()

   NiagaraRendererProperties.h  

Structs

Name Remarks
FPSOPrecacheParams Collect all the data required for PSO precaching

Typedefs

Name Type Remarks Include Path
FOnPropertiesChanged TMulticastDelegate_NoParams< void >   NiagaraRendererProperties.h
FPSOPrecacheParamsList TArray< FPSOPrecacheParams, TInlineAllocator< 2 > >   NiagaraRendererProperties.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowInCullProxies bool   NiagaraRendererProperties.h
  • EditAnywhere
  • Category="Scalability"
bIsEnabled bool   NiagaraRendererProperties.h  
MotionVectorSetting ENiagaraRendererMotionVectorSetting Hint about how to generate motion (velocity) vectors for this renderer. NiagaraRendererProperties.h
  • EditAnywhere
  • Category="Rendering"
OuterEmitterVersion FGuid   NiagaraRendererProperties.h  
Platforms FNiagaraPlatformSet Platforms on which this renderer is enabled. NiagaraRendererProperties.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityContext)
RendererEnabledBinding FNiagaraVariableAttributeBinding Binding to control if the renderer is enabled or disabled. NiagaraRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SortOrderHint int32 By default, emitters are drawn in the order that they are added to the system. NiagaraRendererProperties.h
  • EditAnywhere
  • Category="Rendering"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CacheFromCompiledData ( const FNiagaraDataSetCompiledData* CompiledData
)

   NiagaraRendererProperties.h  

virtual void CollectPSOPrecacheData ( const FNiagaraEmitterInstance* InEmitter,
FPSOPrecacheParamsList& OutParams
) const

   NiagaraRendererProperties.h  

void CollectPSOPrecacheData ( FNiagaraEmitterInstance* EmitterInstance,
FMaterialInterfacePSOPrecacheParamsList& MaterialInterfacePSOPrecacheParamsList
) const

 Collect PSO precache data using the optional emitter instance NiagaraRendererProperties.h  

uint32 ComputeMaxUsedComponents ( const FNiagaraDataSetCompiledData* CompiledDataSetData
) const

   NiagaraRendererProperties.h  

virtual FNiagaraBoundsCalculator * CreateBoundsCalculator()

   NiagaraRendererProperties.h  

void CreateDefaultRendererWidget ( TArray< TSharedPtr< SWidget > >& OutWidgets
) const

   NiagaraRendererProperties.h  

virtual FNiagaraRenderer * CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel,
const FNiagaraEmitterInstance* Emitter,
const FNiagaraSystemInstanceController& InController
)

   NiagaraRendererProperties.h  

void CreateRendererWidgetsForAssets ( TConstArrayView< UMaterialInterface* > InMaterials,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool,
TArray< TSharedPtr< SWidget > >& OutWidgets
) const

   NiagaraRendererProperties.h  

void CreateRendererWidgetsForAssets ( TConstArrayView< UObject* > InAssets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool,
TArray< TSharedPtr< SWidget > >& OutWidgets
) const

   NiagaraRendererProperties.h  

virtual void FixMaterial ( UMaterial* Material
)

   NiagaraRendererProperties.h  

void ForEachPlatformSet ( TAction Func
)

   NiagaraRendererProperties.h  

virtual void GetAdditionalVariables ( TArray< FNiagaraVariableBase >& OutArray
) const

   NiagaraRendererProperties.h  

virtual void GetAssetTagsForContext ( const UObject* InAsset,
FGuid AssetVersion,
const TArray< const UNiagaraRendererProperties* >& InProperties,
TMap< FName, uint32 >& NumericKeys,
TMap< FName, FString >& StringKeys
) const

 Method to add asset tags that are specific to this renderer. NiagaraRendererProperties.h  

const TArray< const FNiagaraVariableAttributeBinding * > & GetAttributeBindings()

   NiagaraRendererProperties.h  

virtual FNiagaraVariable GetBoundAttribute ( const FNiagaraVariableAttributeBinding* Binding
) const

 Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties. NiagaraRendererProperties.h  

virtual TArray< FNiagaraVariable > GetBoundAttributes()

   NiagaraRendererProperties.h  

virtual ENiagaraRendererSourceDataMode GetCurrentSourceMode()

   NiagaraRendererProperties.h  

virtual TOptional< FText > GetDebugDrawTooltip()

   NiagaraRendererProperties.h  

FVersionedNiagaraEmitterData * GetEmitterData()

   NiagaraRendererProperties.h  

virtual bool GetIsActive()

   NiagaraRendererProperties.h  

virtual bool GetIsEnabled()

   NiagaraRendererProperties.h  

virtual float GetMaterialStreamingScale()

   NiagaraRendererProperties.h  
  NiagaraRendererProperties.h  

void GetMaterialUsageFeedback ( EMaterialUsage Usage,
TConstArrayView< EMaterialDomain > InvalidMaterialDomains,
TArray< FNiagaraRendererFeedback >& OutFeedback
) const

   NiagaraRendererProperties.h  

virtual const TArray< FNiagaraVariable > & GetOptionalAttributes()

   NiagaraRendererProperties.h  

FVersionedNiagaraEmitter GetOuterEmitter()

   NiagaraRendererProperties.h  

FVersionedNiagaraEmitterBase GetOuterEmitterBase()

   NiagaraRendererProperties.h  

virtual void GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FText >& OutErrors,
TArray< FText >& OutWarnings,
TArray< FText >& OutInfo
) const

   NiagaraRendererProperties.h  

virtual void GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FNiagaraRendererFeedback >& OutErrors,
TArray< FNiagaraRendererFeedback >& OutWarnings,
TArray< FNiagaraRendererFeedback >& OutInfo
) const

   NiagaraRendererProperties.h  

virtual void GetRendererMaterialUsageFeedback ( TArray< FNiagaraRendererFeedback >& OutFeedback
) const

 Provides feedback on any material usage issues, i.e. incompatable material assignment or missing usage flags Automaticaly called from GetRendererFeedback where OutFeedback results in Errors NiagaraRendererProperties.h  

virtual void GetRendererTooltipWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraRendererProperties.h  

virtual void GetRendererWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraRendererProperties.h  

virtual const TArray< FNiagaraVariable > & GetRequiredAttributes()

   NiagaraRendererProperties.h  

virtual const FSlateBrush * GetStackIcon()

 The icon to display in the niagara stack widget under the renderer section. NiagaraRendererProperties.h  

virtual void GetStreamingMeshInfo ( const FBoxSphereBounds& OwnerBounds,
const FNiagaraEmitterInstance* InEmitter,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets
) const

   NiagaraRendererProperties.h  

virtual void GetUsedMaterials ( const FNiagaraEmitterInstance* InEmitter,
TArray< UMaterialInterface* >& OutMaterials
) const

   NiagaraRendererProperties.h  

virtual const FVertexFactoryType * GetVertexFactoryType()

   NiagaraRendererProperties.h  

virtual FText GetWidgetDisplayName()

 The text to display in the niagara stack widget under the renderer section. NiagaraRendererProperties.h  

virtual bool IsBackfaceCullingDisabled()

   NiagaraRendererProperties.h  

virtual bool IsDebugDrawEnabled()

   NiagaraRendererProperties.h  

virtual bool IsMaterialValidForRenderer ( UMaterial* Material,
FText& InvalidMessage
)

   NiagaraRendererProperties.h  

virtual bool IsSimTargetSupported ( ENiagaraSimTarget InSimTarget
) const

   NiagaraRendererProperties.h  

virtual bool IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSourceForBinding,
const FName& InTargetBindingName
) const

   NiagaraRendererProperties.h  

virtual bool NeedsMIDsForMaterials()

   NiagaraRendererProperties.h  

bool NeedsPreciseMotionVectors()

   NiagaraRendererProperties.h  

virtual bool NeedsSystemCompletion()

 When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called NiagaraRendererProperties.h  

virtual bool NeedsSystemPostTick()

 When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called NiagaraRendererProperties.h  

virtual bool PopulateRequiredBindings ( FNiagaraParameterStore& InParameterStore
)

 In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation. NiagaraRendererProperties.h  

virtual void RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitter& InEmitter
)

   NiagaraRendererProperties.h  

virtual void RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraRendererProperties.h  

virtual void RenameEmitter ( const FName& InOldName,
const UNiagaraEmitter* InRenamedEmitter
)

 Internal handling of any emitter variable renames. NiagaraRendererProperties.h  

virtual void RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitter& InEmitter
)

   NiagaraRendererProperties.h  

virtual void RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraRendererProperties.h  

virtual void SetDebugDrawEnabled ( bool bInEnabled
)

   NiagaraRendererProperties.h  

virtual void SetIsEnabled ( bool bInIsEnabled
)

   NiagaraRendererProperties.h  

UNiagaraRendererProperties * StaticDuplicateWithNewMergeId ( UObject* InOuter
) const

   NiagaraRendererProperties.h  

virtual bool SupportsDebugDraw()

   NiagaraRendererProperties.h  

bool SupportsEmitterMode()

   NiagaraRendererProperties.h  

virtual bool UseHeterogeneousVolumes()

   NiagaraRendererProperties.h  

ENiagaraRendererSourceDataMode ValidateSourceMode ( ENiagaraRendererSourceDataMode InSourceMode
) const

   NiagaraRendererProperties.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   NiagaraRendererProperties.h  

virtual bool NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetPlatform
) const

   NiagaraRendererProperties.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraRendererProperties.h  

virtual void PostInitProperties()

   NiagaraRendererProperties.h  

virtual void PostLoad()

   NiagaraRendererProperties.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool BuildMaterialStaticParameterSet ( const FNiagaraRendererMaterialParameters& MaterialParameters,
const UMaterialInterface* Material,
FStaticParameterSet& StaticParameterSet
) const

 Generates the static parameter set for the parent emitter NiagaraRendererProperties.h  

int32 GetDynamicParameterChannelMask ( const FVersionedNiagaraEmitterData* EmitterData,
FName BindingName,
int32 DefaultChannelMask
) const

   NiagaraRendererProperties.h  

int32 GetDynamicParameterCombinedChannelMask ( FName Parameter0Name,
FName Parameter1Name,
FName Parameter2Name,
FName Parameter3Name
) const

   NiagaraRendererProperties.h  

void InitParticleDataSetAccessor ( TAccessorType& Accessor,
const FNiagaraDataSetCompiledData* CompiledData,
const FNiagaraVariableAttributeBinding& Binding
)

   NiagaraRendererProperties.h  

virtual void PostLoadBindings ( ENiagaraRendererSourceDataMode InSourceMode
)

   NiagaraRendererProperties.h  
  NiagaraRendererProperties.h  
Utility function to updates MICs. NiagaraRendererProperties.h  

bool UpdateMaterialStaticParameters ( const FNiagaraRendererMaterialParameters& MaterialParameters,
UMaterialInstanceConstant* MIC
)

 Update MIC Static Parameters. NiagaraRendererProperties.h  

virtual void UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

   NiagaraRendererProperties.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ChangeToPositionBinding ( FNiagaraVariableAttributeBinding& Binding
)

 Utility function that can be used to fix up old vec3 bindings into position bindings. NiagaraRendererProperties.h  

static bool IsGpuTranslucentThisFrame ( ERHIFeatureLevel::Type FeatureLevel,
ENiagaraRendererGpuTranslucentLatency Latency
)

 Is the Gpu translucent data going to be this frame, this can be restricted by things like feature level. NiagaraRendererProperties.h  

static bool IsSortHighPrecision ( ENiagaraRendererSortPrecision SortPrecision
)

   NiagaraRendererProperties.h  

static bool ShouldGpuTranslucentThisFrame ( ENiagaraRendererGpuTranslucentLatency Latency
)

 Should the Gpu translucent data be this frame or not? NiagaraRendererProperties.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bMotionBlurEnabled_DEPRECATED bool   NiagaraRendererProperties.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page