UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDynamicEmitterDataBase Struct Referenceabstract

#include <ParticleHelper.h>

+ Inheritance diagram for FDynamicEmitterDataBase:

Public Member Functions

 FDynamicEmitterDataBase (const class UParticleModuleRequired *RequiredModule)
 
virtual ~FDynamicEmitterDataBase ()
 
voidoperator new (size_t Size)
 
void operator delete (void *RawMemory, size_t Size)
 
virtual void UpdateRenderThreadResourcesEmitter (const FParticleSystemSceneProxy *InOwnerProxy)
 
virtual void ReleaseRenderThreadResources (const FParticleSystemSceneProxy *InOwnerProxy)
 
virtual void GetDynamicMeshElementsEmitter (const FParticleSystemSceneProxy *Proxy, const FSceneView *View, const FSceneViewFamily &ViewFamily, int32 ViewIndex, FMeshElementCollector &Collector) const
 
virtual const FMaterialRenderProxyGetMaterialRenderProxy ()=0
 
virtual void GatherSimpleLights (const FParticleSystemSceneProxy *Proxy, const FSceneViewFamily &ViewFamily, FSimpleLightArray &OutParticleLights) const
 
virtual const FDynamicEmitterReplayDataBaseGetSource () const =0
 
virtual const FMacroUVOverrideGetMacroUVOverride () const
 

Public Attributes

TStatId StatID
 
uint32 bSelected:1
 
uint32 bValid:1
 
int32 EmitterIndex
 

Detailed Description

Base class for all emitter types

Constructor & Destructor Documentation

◆ FDynamicEmitterDataBase()

FDynamicEmitterDataBase::FDynamicEmitterDataBase ( const class UParticleModuleRequired RequiredModule)

◆ ~FDynamicEmitterDataBase()

virtual FDynamicEmitterDataBase::~FDynamicEmitterDataBase ( )
inlinevirtual

Member Function Documentation

◆ GatherSimpleLights()

virtual void FDynamicEmitterDataBase::GatherSimpleLights ( const FParticleSystemSceneProxy Proxy,
const FSceneViewFamily ViewFamily,
FSimpleLightArray OutParticleLights 
) const
inlinevirtual

Callback from the renderer to gather simple lights that this proxy wants renderered.

Reimplemented in FDynamicSpriteEmitterData, and FDynamicMeshEmitterData.

◆ GetDynamicMeshElementsEmitter()

virtual void FDynamicEmitterDataBase::GetDynamicMeshElementsEmitter ( const FParticleSystemSceneProxy Proxy,
const FSceneView View,
const FSceneViewFamily ViewFamily,
int32  ViewIndex,
FMeshElementCollector Collector 
) const
inlinevirtual

◆ GetMacroUVOverride()

virtual const FMacroUVOverride & FDynamicEmitterDataBase::GetMacroUVOverride ( ) const
inlinevirtual

Returns the current macro uv override. Specialized by FGPUSpriteDynamicEmitterData

Reimplemented in FGPUSpriteDynamicEmitterData.

◆ GetMaterialRenderProxy()

virtual const FMaterialRenderProxy * FDynamicEmitterDataBase::GetMaterialRenderProxy ( )
pure virtual

Retrieve the material render proxy to use for rendering this emitter. PURE VIRTUAL

Parameters
bSelectedWhether the object is selected
Returns
FMaterialRenderProxy* The material proxt to render with.

Implemented in FDynamicSpriteEmitterDataBase, and FGPUSpriteDynamicEmitterData.

◆ GetSource()

virtual const FDynamicEmitterReplayDataBase & FDynamicEmitterDataBase::GetSource ( ) const
pure virtual

◆ operator delete()

void FDynamicEmitterDataBase::operator delete ( void RawMemory,
size_t  Size 
)

◆ operator new()

void * FDynamicEmitterDataBase::operator new ( size_t  Size)

Custom new/delete with recycling

◆ ReleaseRenderThreadResources()

virtual void FDynamicEmitterDataBase::ReleaseRenderThreadResources ( const FParticleSystemSceneProxy InOwnerProxy)
inlinevirtual

Release the render thread resources for this emitter data

Parameters
InOwnerProxyThe proxy that owns this dynamic emitter data

Reimplemented in FGPUSpriteDynamicEmitterData, and FDynamicMeshEmitterData.

◆ UpdateRenderThreadResourcesEmitter()

virtual void FDynamicEmitterDataBase::UpdateRenderThreadResourcesEmitter ( const FParticleSystemSceneProxy InOwnerProxy)
inlinevirtual

Create the render thread resources for this emitter data

Parameters
InOwnerProxyThe proxy that owns this dynamic emitter data

Reimplemented in FGPUSpriteDynamicEmitterData, FDynamicSpriteEmitterData, and FDynamicMeshEmitterData.

Member Data Documentation

◆ bSelected

uint32 FDynamicEmitterDataBase::bSelected

true if this emitter is currently selected

◆ bValid

uint32 FDynamicEmitterDataBase::bValid

true if this emitter has valid rendering data

◆ EmitterIndex

int32 FDynamicEmitterDataBase::EmitterIndex

◆ StatID

TStatId FDynamicEmitterDataBase::StatID
mutable

Stat id of this object, 0 if nobody asked for it yet


The documentation for this struct was generated from the following files: