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

Light Theme

Dark Theme

FParticleSystemSceneProxy

Scene Proxies

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FPrimitiveSceneProxy

FParticleSystemSceneProxy

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ParticleHelper.h
Include	#include "ParticleHelper.h"

Syntax

class FParticleSystemSceneProxy : public FPrimitiveSceneProxy

Remarks

Scene Proxies

Variables

	Name	Description
uint8: 1	bCastShadow
uint8: 1	bManagingSignificance
FColoredMateria...	DeselectedWireframeMaterialInstance
FParticleDynami...	DynamicData
TArray< FDynami...	DynamicDataForThisFrame
TEnumAsByte< ER...	FeatureLevel
int32	FirstFreeMeshBatch
FParticleDynami...	LastDynamicData
int32	LastFramePreRendered	From ViewFamily.FrameNumber
int32	LODMethod
FMaterialReleva...	MaterialRelevance
TIndirectArray<...	MeshBatchPool	Pool for holding FMeshBatches to reduce allocations.
TArray< int32 >	MeshEmitterLODIndices	Persistent proxy storage for mesh emitter LODs; need to store these here, because GDME needs to calc the index, but VF needs to be init'ed with the correct LOD, and DynamicData goes away every frame
AActor *	Owner
float	PendingLODDistance
FParticlePerfSt...	PerfStatContext
int32	VisualizeLODIndex
TUniformBuffer<...	WorldSpacePrimitiveUniformBuffer	The primitive's uniform buffer. Mutable because it is cached state during GetDynamicMeshElements.

Constructors

	Name	Description
	FParticleSystemSceneProxy ( UParticleSystemComponent* Comp..., FParticleDynamicData* InDynami..., bool bCanBeOccluded )	Initialization constructor.

Destructors

	Name	Description
	~FParticleSystemSceneProxy()

Functions

	Name	Description
void	CreateRenderThreadResourcesForEmitterData()	Allows dynamic emitter data to create render thread resources.
void	DetermineLODDistance ( const FSceneView* View, int32 FrameNumber )
uint32	GetAllocatedSize()
bool	GetCastShadow()
const FColor...	GetDeselectedWireframeMatInst()
FParticleDyn...	GetDynamicData()
ERHIFeatureL...	GetFeatureLevel()
FParticleDyn...	GetLastDynamicData()
const FMater...	GetMaterialRelevance()
void	GetObjectPositionAndScale ( const FSceneView& View, FVector2D& ObjectNDCPosition, FVector2D& ObjectMacroUVScales )	Object position in post projection space.
float	GetPendingLODDistance()
FMeshBatch &...	GetPooledMeshBatch()	Gets a mesh batch from the pool.
int32	GetVisualizeLODIndex()
FRHIUniformB...	GetWorldSpacePrimitiveUniformBuffer()
FMatrix	GetWorldToLocal()	While this isn't good OO design, access to everything is made public.
void	ReleaseRenderThreadResources()	Called when the rendering thread removes the dynamic data from the scene.
void	ReleaseRenderThreadResourcesForEmitterData()	Allows dynamic emitter data to release render thread resources.
void	SetLastDynamicData ( FParticleDynamicData* InLastDy... )
void	SetVisualizeLODIndex ( int32 InVisualizeLODIndex )
void	UpdateData ( FParticleDynamicData* NewDynam... )
void	UpdateData_RenderThread ( FParticleDynamicData* NewDynam... )
void	UpdateWorldSpacePrimitiveUniformBuffer()	Called by dynamic emitter data during initialization to make sure the world space primitive uniform buffer is up-to-date.

Overridden from FPrimitiveSceneProxy

	Name	Description
bool	CanBeOccluded()
void	CreateRenderThreadResources()	Called when the rendering thread adds the proxy to the scene.
void	GatherSimpleLights ( const FSceneViewFamily& ViewFamily, FSimpleLightArray& OutParticleLigh... )	Gathers simple lights for this emitter.
FBoxSphereBo...	GetCustomOcclusionBounds()	Return the custom occlusion bounds for this scene proxy.
void	GetDynamicMeshElements ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, FMeshElementCollector& Collector )	Gathers the primitive's dynamic mesh elements.
uint32	GetMemoryFootprint()	Every derived class should override these functions
SIZE_T	GetTypeHash()	Return a type (or subtype) specific hash for sorting purposes
FPrimitiveVi...	GetViewRelevance ( const FSceneView* View )	Determines the relevance of this primitive's elements to the given view.
bool	HasCustomOcclusionBounds()	Returns whether the proxy utilizes custom occlusion bounds or not
void	OnTransformChanged()	Called to notify the proxy when its transform has been updated.