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

Light Theme

Dark Theme

UNiagaraLightRendererProperties

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

UNiagaraLightRendererProperties

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, MinimalAPI, Meta=(DisplayName="Light Renderer"))
class UNiagaraLightRendererProperties : public UNiagaraRendererProperties

Variables

	Name	Description
uint32: 1	bAffectsTranslucency	Whether lights from this renderer should affect translucency.
uint32: 1	bAlphaScalesBrightness	When checked, will treat the alpha value of the particle's color as a multiplier of the light's brightness.
uint32: 1	bUseInverseSquaredFalloff	Whether to use physically based inverse squared falloff from the light.
FVector	ColorAdd	A static color shift applied to each rendered light
FNiagaraVariabl...	ColorBinding	Which attribute should we use for light color when generating lights?
FNiagaraDataSet...	ColorDataSetAccessor
float	DefaultExponent	The exponent to use for all lights if no exponent binding was found
FNiagaraDataSet...	EnabledDataSetAccessor
FNiagaraDataSet...	ExponentDataSetAccessor
FNiagaraVariabl...	LightExponentBinding	Which attribute should we use for the light's exponent when inverse squared falloff is disabled?
FNiagaraVariabl...	LightRenderingEnabledBinding	Which attribute should we use to check if light rendering should be enabled for a particle? This can be used to control the spawn-rate on a per-particle basis.
FNiagaraVariabl...	PositionBinding	Which attribute should we use for position when generating lights?
FNiagaraDataSet...	PositionDataSetAccessor
FNiagaraVariabl...	RadiusBinding	Which attribute should we use for light radius when generating lights?
FNiagaraDataSet...	RadiusDataSetAccessor
float	RadiusScale	A factor used to scale each particle light radius
int32	RendererVisibility	If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
FNiagaraDataSet...	RendererVisibilityTagAccessor
FNiagaraVariabl...	RendererVisibilityTagBinding	Which attribute should we use for the renderer visibility tag?
FNiagaraDataSet...	ScatteringDataSetAccessor
FNiagaraVariabl...	VolumetricScatteringBinding	Which attribute should we use for the intensity of the volumetric scattering from this light? This scales the light's intensity and color.

Constructors

	Name	Description
	UNiagaraLightRendererProperties()

Functions

		Name	Description
	void	InitCDOPropertiesAfterModuleStartup()	The bindings depend on variables that are created during the NiagaraModule startup.

Overridden from UNiagaraRendererProperties

		Name	Description
	void	CacheFromCompiledData ( const FNiagaraDataSetCompiledData&... )
	FNiagaraBoun...	CreateBoundsCalculator()
	FNiagaraRend...	CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel, const FNiagaraEmitterInstance..., const UNiagaraComponent InCom... )
	void	FixMaterial ( UMaterial* Material )
	const TArray...	GetOptionalAttributes()
	void	GetRendererFeedback ( const UNiagaraEmitter* InEmitt..., TArray< FText >& OutErrors, TArray< FText >& OutWarnings, TArray< FText >& OutInfo )
	void	GetRendererTooltipWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
	void	GetRendererWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
	void	GetUsedMaterials ( const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
	bool	IsMaterialValidForRenderer ( UMaterial* Material, FText& InvalidMessage )
	bool	IsSimTargetSupported ( ENiagaraSimTarget InSimTarget )

Overridden from UObject

		Name	Description
	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.

Constants

Name	Description
LightRendererPropertiesToDeferredInit

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

Take our survey

Dismiss