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 > UNiagaraRendererProperties

Light Theme

Dark Theme

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.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

	UNiagaraComponentRendererProperties
	UNiagaraLightRendererProperties
	UNiagaraMeshRendererProperties
	UNiagaraRibbonRendererProperties
	UNiagaraSpriteRendererProperties

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraRendererProperties.h
Include	#include "NiagaraRendererProperties.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class UNiagaraRendererProperties : public UNiagaraMergeable

Remarks

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.

Variables

	Name	Description
TArray< const F...	AttributeBindings
bool	bIsEnabled
TArray< FNiagar...	CurrentBoundAttributes	Copy of variables in the attribute binding, updated when GetBoundAttributes() is called.
ENiagaraRendere...	MotionVectorSetting	Hint about how to generate motion (velocity) vectors for this renderer.
FNiagaraPlatfor...	Platforms	Platforms on which this renderer is enabled.
int32	SortOrderHint	By default, emitters are drawn in the order that they are added to the system.

Constructors

	Name	Description
	UNiagaraRendererProperties()

Functions

	Name	Description
void	CacheFromCompiledData ( const FNiagaraDataSetCompiledData&... )
uint32	ComputeMaxUsedComponents ( const FNiagaraDataSetCompiledData&... )
FNiagaraBoun...	CreateBoundsCalculator()
FNiagaraRend...	CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel, const FNiagaraEmitterInstance..., const UNiagaraComponent InCom... )
void	FixMaterial ( UMaterial* Material )
void	GetAdditionalVariables ( TArray< FNiagaraVariableBase >& Ou... )
void	GetAssetTagsForContext ( const UObject* InAsset, const TArray< const UNiagaraRendere..., TMap< FName, uint32 >& NumericKeys, TMap< FName, FString >& StringKeys )	Method to add asset tags that are specific to this renderer.
const TArray...	GetAttributeBindings()
const TArray...	GetBoundAttributes()
ENiagaraRend...	GetCurrentSourceMode()
bool	GetIsActive()
bool	GetIsEnabled()
const TArray...	GetOptionalAttributes()
void	GetRendererFeedback ( const UNiagaraEmitter* InEmitt..., TArray< FText >& OutErrors, TArray< FText >& OutWarnings, TArray< FText >& OutInfo )
void	GetRendererFeedback ( UNiagaraEmitter* InEmitter, TArray< FNiagaraRendererFeedback > ..., TArray< FNiagaraRendererFeedback > ..., TArray< FNiagaraRendererFeedback > ... )
void	GetRendererTooltipWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetRendererWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
const TArray...	GetRequiredAttributes()
const FSlate...	GetStackIcon()	The icon to display in the niagara stack widget under the renderer section.
void	GetUsedMaterials ( const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
FText	GetWidgetDisplayName()	The text to display in the niagara stack widget under the renderer section.
bool	IsMaterialValidForRenderer ( UMaterial* Material, FText& InvalidMessage )
bool	IsSimTargetSupported ( ENiagaraSimTarget InSimTarget )
bool	IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSour..., const FName& InTargetBindingName )
bool	NeedsMIDsForMaterials()
bool	NeedsPreciseMotionVectors()
bool	NeedsSystemCompletion()	When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called
bool	NeedsSystemPostTick()	When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called
bool	PopulateRequiredBindings ( FNiagaraParameterStore& InParamete... )	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.
void	PostLoadBindings ( ENiagaraRendererSourceDataMode InSo... )
void	RemoveVariable ( const FNiagaraVariableBase& OldVar..., const UNiagaraEmitter* InEmitt... )
void	RenameEmitter ( const FName& InOldName, const UNiagaraEmitter* InRenam... )	Internal handling of any emitter variable renames.
void	RenameVariable ( const FNiagaraVariableBase& OldVar..., const FNiagaraVariableBase& NewVar..., const UNiagaraEmitter* InEmitt... )
void	SetIsEnabled ( bool bInIsEnabled )
UNiagaraRend...	StaticDuplicateWithNewMergeId ( UObject* InOuter )
void	UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSo..., bool bFromPropertyEdit )

Overridden from UObject

	Name	Description
bool	NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetP... )	Called during saving to determine the load flags to save with the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

		Name	Description
	bool	bMotionBlurEnabled_DEPRECATED

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

Take our survey

Dismiss