UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FGPUSpriteDynamicEmitterData Struct Reference
+ Inheritance diagram for FGPUSpriteDynamicEmitterData:

Public Member Functions

 FGPUSpriteDynamicEmitterData (const UParticleModuleRequired *InRequiredModule)
 
 ~FGPUSpriteDynamicEmitterData ()
 
bool RendersWithTranslucentMaterial () const
 
virtual void UpdateRenderThreadResourcesEmitter (const FParticleSystemSceneProxy *InOwnerProxy) override
 
virtual void ReleaseRenderThreadResources (const FParticleSystemSceneProxy *InOwnerProxy) override
 
virtual void GetDynamicMeshElementsEmitter (const FParticleSystemSceneProxy *Proxy, const FSceneView *View, const FSceneViewFamily &ViewFamily, int32 ViewIndex, FMeshElementCollector &Collector) const override
 
const FMaterialRenderProxyGetMaterialRenderProxy () const
 
virtual const FMaterialRenderProxyGetMaterialRenderProxy () override
 
virtual const FDynamicEmitterReplayDataBaseGetSource () const override
 
virtual const FMacroUVOverrideGetMacroUVOverride () const
 
- Public Member Functions inherited from FDynamicEmitterDataBase
 FDynamicEmitterDataBase (const class UParticleModuleRequired *RequiredModule)
 
virtual ~FDynamicEmitterDataBase ()
 
voidoperator new (size_t Size)
 
void operator delete (void *RawMemory, size_t Size)
 
virtual void GatherSimpleLights (const FParticleSystemSceneProxy *Proxy, const FSceneViewFamily &ViewFamily, FSimpleLightArray &OutParticleLights) const
 

Public Attributes

FMaterialRenderProxyMaterialProxy
 
bool bIsMaterialTranslucent
 
FFXSystemFXSystem
 
FGPUSpriteResourcesResources
 
FParticleSimulationGPUSimulation
 
FBox SimulationBounds
 
TArray< FNewParticleNewParticles
 
TArray< uint32TilesToClear
 
FMatrix LocalVectorFieldToWorld
 
float LocalVectorFieldIntensity
 
float LocalVectorFieldTightness
 
FParticlePerFrameSimulationParameters PerFrameSimulationParameters
 
FGPUSpriteEmitterDynamicUniformParameters EmitterDynamicParameters
 
EParticleSortMode SortMode
 
bool bUseLocalSpace
 
uint32 bLocalVectorFieldTileX: 1
 
uint32 bLocalVectorFieldTileY: 1
 
uint32 bLocalVectorFieldTileZ: 1
 
uint32 bLocalVectorFieldUseFixDT: 1
 
FMacroUVOverride MacroUVOverride
 
- Public Attributes inherited from FDynamicEmitterDataBase
TStatId StatID
 
uint32 bSelected:1
 
uint32 bValid:1
 
int32 EmitterIndex
 

Detailed Description

Dynamic emitter data for Cascade.

Constructor & Destructor Documentation

◆ FGPUSpriteDynamicEmitterData()

FGPUSpriteDynamicEmitterData::FGPUSpriteDynamicEmitterData ( const UParticleModuleRequired InRequiredModule)
inlineexplicit

Constructor.

◆ ~FGPUSpriteDynamicEmitterData()

FGPUSpriteDynamicEmitterData::~FGPUSpriteDynamicEmitterData ( )
inline

Member Function Documentation

◆ GetDynamicMeshElementsEmitter()

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

Reimplemented from FDynamicEmitterDataBase.

◆ GetMacroUVOverride()

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

Returns the current macro uv override.

Reimplemented from FDynamicEmitterDataBase.

◆ GetMaterialRenderProxy() [1/2]

const FMaterialRenderProxy * FGPUSpriteDynamicEmitterData::GetMaterialRenderProxy ( ) const
inline

Retrieves the material render proxy with which to render sprites. Const version of the virtual below, needed because GetDynamicMeshElementsemitter is const

◆ GetMaterialRenderProxy() [2/2]

virtual const FMaterialRenderProxy * FGPUSpriteDynamicEmitterData::GetMaterialRenderProxy ( )
inlineoverridevirtual

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.

Implements FDynamicEmitterDataBase.

◆ GetSource()

virtual const FDynamicEmitterReplayDataBase & FGPUSpriteDynamicEmitterData::GetSource ( ) const
inlineoverridevirtual

Emitter replay data. A dummy value is returned as data is stored on the GPU.

Implements FDynamicEmitterDataBase.

◆ ReleaseRenderThreadResources()

virtual void FGPUSpriteDynamicEmitterData::ReleaseRenderThreadResources ( const FParticleSystemSceneProxy InOwnerProxy)
inlineoverridevirtual

Called to release render thread resources.

Reimplemented from FDynamicEmitterDataBase.

◆ RendersWithTranslucentMaterial()

bool FGPUSpriteDynamicEmitterData::RendersWithTranslucentMaterial ( ) const
inline

◆ UpdateRenderThreadResourcesEmitter()

virtual void FGPUSpriteDynamicEmitterData::UpdateRenderThreadResourcesEmitter ( const FParticleSystemSceneProxy InOwnerProxy)
inlineoverridevirtual

Called to create render thread resources.

Reimplemented from FDynamicEmitterDataBase.

Member Data Documentation

◆ bIsMaterialTranslucent

bool FGPUSpriteDynamicEmitterData::bIsMaterialTranslucent

◆ bLocalVectorFieldTileX

uint32 FGPUSpriteDynamicEmitterData::bLocalVectorFieldTileX

Tile vector field in x axis?

◆ bLocalVectorFieldTileY

uint32 FGPUSpriteDynamicEmitterData::bLocalVectorFieldTileY

Tile vector field in y axis?

◆ bLocalVectorFieldTileZ

uint32 FGPUSpriteDynamicEmitterData::bLocalVectorFieldTileZ

Tile vector field in z axis?

◆ bLocalVectorFieldUseFixDT

uint32 FGPUSpriteDynamicEmitterData::bLocalVectorFieldUseFixDT

Tile vector field in z axis?

◆ bUseLocalSpace

bool FGPUSpriteDynamicEmitterData::bUseLocalSpace

Whether to render particles in local space or world space.

◆ EmitterDynamicParameters

FGPUSpriteEmitterDynamicUniformParameters FGPUSpriteDynamicEmitterData::EmitterDynamicParameters

Per-emitter parameters that may change

◆ FXSystem

FFXSystem* FGPUSpriteDynamicEmitterData::FXSystem

FX system.

◆ LocalVectorFieldIntensity

float FGPUSpriteDynamicEmitterData::LocalVectorFieldIntensity

Vector field scale.

◆ LocalVectorFieldTightness

float FGPUSpriteDynamicEmitterData::LocalVectorFieldTightness

Vector field tightness.

◆ LocalVectorFieldToWorld

FMatrix FGPUSpriteDynamicEmitterData::LocalVectorFieldToWorld

Vector field-to-world transform.

◆ MacroUVOverride

FMacroUVOverride FGPUSpriteDynamicEmitterData::MacroUVOverride

Current MacroUV override settings

◆ MaterialProxy

FMaterialRenderProxy* FGPUSpriteDynamicEmitterData::MaterialProxy

◆ NewParticles

TArray<FNewParticle> FGPUSpriteDynamicEmitterData::NewParticles

A list of new particles to inject in to the simulation for this emitter.

◆ PerFrameSimulationParameters

FParticlePerFrameSimulationParameters FGPUSpriteDynamicEmitterData::PerFrameSimulationParameters

Per-frame simulation parameters.

◆ Resources

FGPUSpriteResources* FGPUSpriteDynamicEmitterData::Resources

Per-emitter resources.

◆ Simulation

FParticleSimulationGPU* FGPUSpriteDynamicEmitterData::Simulation

Simulation resources.

◆ SimulationBounds

FBox FGPUSpriteDynamicEmitterData::SimulationBounds

Bounds for particles in the simulation.

◆ SortMode

EParticleSortMode FGPUSpriteDynamicEmitterData::SortMode

How the particles should be sorted, if at all.

◆ TilesToClear

TArray<uint32> FGPUSpriteDynamicEmitterData::TilesToClear

A list of tiles to clear that were newly allocated for this emitter.


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