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

Light Theme

Dark Theme

UNiagaraMeshRendererProperties

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

UNiagaraMeshRendererProperties

References

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

Syntax

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

Variables

	Name	Description
uint32: 1	bEnableCameraDistanceCulling	Enables frustum culling of individual mesh particles
uint32: 1	bEnableFrustumCulling	Enables frustum culling of individual mesh particles
uint32: 1	bEnableMeshFlipbook	When checked, will treat 'ParticleMesh' as the first frame of the flipbook, and will use the other mesh flipbook options to find the other frames
uint32: 1	bLockedAxisEnable	If true and in a non-default facing mode, will lock facing direction to an arbitrary plane of rotation
uint32: 1	bOverrideMaterials	Whether or not to use the OverrideMaterials array instead of the mesh's existing materials.
uint32: 1	bSortOnlyWhenTranslucent	If true, the particles are only sorted when using a translucent material.
uint32: 1	bSubImageBlend	If true, blends the sub-image UV lookup with its next adjacent member using the fractional part of the SubImageIndex float value as the linear interpolation factor.
FNiagaraVariabl...	CameraOffsetBinding	Which attribute should we use for camera offset when rendering meshes?
FNiagaraVariabl...	ColorBinding	Which attribute should we use for color when generating instanced meshes?
FNiagaraVariabl...	CustomSortingBinding	Which attribute should we use custom sorting of particles in this emitter.
FNiagaraVariabl...	DynamicMaterial1Binding	Which attribute should we use for dynamic material parameters when generating instanced meshes?
FNiagaraVariabl...	DynamicMaterial2Binding	Which attribute should we use for dynamic material parameters when generating instanced meshes?
FNiagaraVariabl...	DynamicMaterial3Binding	Which attribute should we use for dynamic material parameters when generating instanced meshes?
FNiagaraVariabl...	DynamicMaterialBinding	Which attribute should we use for dynamic material parameters when generating instanced meshes?
ENiagaraMeshFac...	FacingMode	Determines how the mesh orients itself relative to the camera.
UStaticMesh ...	FirstFlipbookFrame	The static mesh to use for the first frame of the flipbook.
FString	FlipbookSuffixFormat	Provides the format of the suffix of the names of the static meshes when searching for flipbook frames.
uint32	FlipbookSuffixNumDigits	The number of digits to expect in the frame number of the flipbook page.
FVector	LockedAxis	Arbitrary axis by which to lock facing rotations
ENiagaraMeshLoc...	LockedAxisSpace	Specifies what space the locked axis is in
TArray< FNiagar...	MaterialParameterBindings	If this array has entries, we will create a MaterialInstanceDynamic per Emitter instance from Material and set the Material parameters using the Niagara simulation variables listed.
uint32	MaterialParamValidMask
FNiagaraVariabl...	MaterialRandomBinding	Which attribute should we use for material randoms when generating instanced meshes?
float	MaxCameraDistance
TArray< FNiagar...	Meshes	The static mesh(es) to be instanced when rendering mesh particles.
FNiagaraVariabl...	MeshIndexBinding	Which attribute should we use to pick the element in the mesh array on the mesh renderer?
FNiagaraVariabl...	MeshOrientationBinding	Which attribute should we use for orienting meshes when generating instanced meshes?
float	MinCameraDistance
FNiagaraVariabl...	NormalizedAgeBinding	Which attribute should we use for Normalized Age?
uint32	NumFlipbookFrames	The number of frames (static meshes) to be included in the flipbook.
TArray< FNiagar...	OverrideMaterials	The materials to be used instead of the StaticMesh's materials.
FNiagaraVariabl...	PositionBinding	Which attribute should we use for position when generating instanced meshes?
FNiagaraVariabl...	PrevCameraOffsetBinding
FNiagaraVariabl...	PrevMeshOrientationBinding
FNiagaraVariabl...	PrevPositionBinding
FNiagaraVariabl...	PrevScaleBinding
FNiagaraVariabl...	PrevVelocityBinding
FNiagaraRendere...	RendererLayoutWithCustomSorting
FNiagaraRendere...	RendererLayoutWithoutCustomSorting
uint32	RendererVisibility	If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
FNiagaraVariabl...	RendererVisibilityTagBinding	Which attribute should we use for the renderer visibility tag?
FNiagaraVariabl...	ScaleBinding	Which attribute should we use for scale when generating instanced meshes?
ENiagaraSortMod...	SortMode	Determines how we sort the particles prior to rendering.
ENiagaraRendere...	SourceMode	Whether or not to draw a single element for the Emitter or to draw the particles.
FNiagaraVariabl...	SubImageIndexBinding	Which attribute should we use for sprite sub-image indexing when generating sprites?
FVector2D	SubImageSize	When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y.
FNiagaraVariabl...	VelocityBinding	Which attribute should we use for velocity when generating instanced meshes?

Constructors

	Name	Description
	UNiagaraMeshRendererProperties()

Functions

	Name	Description
bool	ChangeRequiresMeshListRebuild ( const FProperty* Property )
void	CheckMaterialUsage()
void	GetUsedMeshMaterials ( int32 MeshIndex, const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
void	InitBindings()
void	InitCDOPropertiesAfterModuleStartup()	The bindings depend on variables that are created during the NiagaraModule startup.
void	OnAssetReimported ( UObject* )
void	OnMeshChanged()
void	OnMeshPostBuild ( UStaticMesh* )
void	RebuildMeshList()
void	SetPreviousBindings ( const UNiagaraEmitter* SrcEmit..., ENiagaraRendererSourceDataMode InSo... )

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 )
void	GetAdditionalVariables ( TArray< FNiagaraVariableBase >& Ou... )
ENiagaraRend...	GetCurrentSourceMode()
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 )
bool	IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSour..., const FName& InTargetBindingName )
bool	NeedsMIDsForMaterials()
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	RemoveVariable ( const FNiagaraVariableBase& OldVar..., const UNiagaraEmitter* InEmitt... )
void	RenameVariable ( const FNiagaraVariableBase& OldVar..., const FNiagaraVariableBase& NewVar..., const UNiagaraEmitter* InEmitt... )
void	UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSo..., bool bFromPropertyEdit )

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying 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.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
MeshRendererPropertiesToDeferredInit

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

Take our survey

Dismiss