UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDynamicRibbonEmitterData Struct Reference

#include <ParticleHelper.h>

+ Inheritance diagram for FDynamicRibbonEmitterData:

Public Member Functions

 FDynamicRibbonEmitterData (const UParticleModuleRequired *RequiredModule)
 
virtual ~FDynamicRibbonEmitterData ()
 
virtual void Init (bool bInSelected)
 
virtual void RenderDebug (const FParticleSystemSceneProxy *Proxy, FPrimitiveDrawInterface *PDI, const FSceneView *View, bool bCrosses) const
 
virtual int32 FillVertexData (struct FAsyncBufferFillData &Data) const
 
virtual const FDynamicRibbonEmitterReplayDataGetSourceData () const
 
- Public Member Functions inherited from FDynamicTrailsEmitterData
 FDynamicTrailsEmitterData (const UParticleModuleRequired *RequiredModule)
 
 ~FDynamicTrailsEmitterData ()
 
virtual void GetDynamicMeshElementsEmitter (const FParticleSystemSceneProxy *Proxy, const FSceneView *View, const FSceneViewFamily &ViewFamily, int32 ViewIndex, FMeshElementCollector &Collector) const override
 
virtual int32 FillIndexData (struct FAsyncBufferFillData &Data) const
 
virtual const FDynamicEmitterReplayDataBaseGetSource () const override
 
virtual void DoBufferFill (FAsyncBufferFillData &Me) const override
 
virtual int32 GetDynamicVertexStride (ERHIFeatureLevel::Type) const override
 
virtual int32 GetDynamicParameterVertexStride () const override
 
virtual void GetIndexAllocInfo (int32 &OutNumIndices, int32 &OutStride) const override
 
- Public Member Functions inherited from FDynamicSpriteEmitterDataBase
 FDynamicSpriteEmitterDataBase (const UParticleModuleRequired *RequiredModule)
 
virtual ~FDynamicSpriteEmitterDataBase ()
 
const FMaterialRenderProxyGetMaterialRenderProxy ()
 
void SortSpriteParticles (int32 SortMode, bool bLocalSpace, int32 ParticleCount, const uint8 *ParticleData, int32 ParticleStride, const uint16 *ParticleIndices, const FSceneView *View, const FMatrix &LocalToWorld, FParticleOrder *ParticleOrder) const
 
void BuildViewFillData (const FParticleSystemSceneProxy *Proxy, const FSceneView *InView, int32 InVertexCount, int32 InVertexSize, int32 InDynamicParameterVertexSize, FGlobalDynamicIndexBuffer &DynamicIndexBuffer, FGlobalDynamicVertexBuffer &DynamicVertexBuffer, FGlobalDynamicVertexBufferAllocation &DynamicVertexAllocation, FGlobalDynamicIndexBufferAllocation &DynamicIndexAllocation, FGlobalDynamicVertexBufferAllocation *DynamicParameterAllocation, FAsyncBufferFillData &Data) 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 UpdateRenderThreadResourcesEmitter (const FParticleSystemSceneProxy *InOwnerProxy)
 
virtual void ReleaseRenderThreadResources (const FParticleSystemSceneProxy *InOwnerProxy)
 
virtual void GatherSimpleLights (const FParticleSystemSceneProxy *Proxy, const FSceneViewFamily &ViewFamily, FSimpleLightArray &OutParticleLights) const
 
virtual const FMacroUVOverrideGetMacroUVOverride () const
 

Public Attributes

FDynamicRibbonEmitterReplayData Source
 
uint32 RenderAxisOption:2
 
- Public Attributes inherited from FDynamicTrailsEmitterData
FDynamicTrailsEmitterReplayDataSourcePointer
 
int32 LastFramePreRendered
 
uint32 bClipSourceSegement:1
 
uint32 bRenderGeometry:1
 
uint32 bRenderParticles:1
 
uint32 bRenderTangents:1
 
uint32 bRenderTessellation:1
 
uint32 bTextureTileDistance:1
 
float DistanceTessellationStepSize
 
float TangentTessellationScalar
 
float TextureTileDistance
 
- Public Attributes inherited from FDynamicSpriteEmitterDataBase
const FMaterialRenderProxyMaterialResource
 
uint32 bUsesDynamicParameter:1
 
- Public Attributes inherited from FDynamicEmitterDataBase
TStatId StatID
 
uint32 bSelected:1
 
uint32 bValid:1
 
int32 EmitterIndex
 

Detailed Description

Dynamic emitter data for Ribbon emitters

Constructor & Destructor Documentation

◆ FDynamicRibbonEmitterData()

FDynamicRibbonEmitterData::FDynamicRibbonEmitterData ( const UParticleModuleRequired RequiredModule)
inline

◆ ~FDynamicRibbonEmitterData()

virtual FDynamicRibbonEmitterData::~FDynamicRibbonEmitterData ( )
inlinevirtual

Member Function Documentation

◆ FillVertexData()

int32 FDynamicRibbonEmitterData::FillVertexData ( struct FAsyncBufferFillData Data) const
virtual

Reimplemented from FDynamicTrailsEmitterData.

◆ GetSourceData()

virtual const FDynamicRibbonEmitterReplayData * FDynamicRibbonEmitterData::GetSourceData ( ) const
inlinevirtual

Get the source replay data for this emitter

Reimplemented from FDynamicTrailsEmitterData.

◆ Init()

void FDynamicRibbonEmitterData::Init ( bool  bInSelected)
virtual

Initialize this emitter's dynamic rendering data, called after source data has been filled in

Reimplemented from FDynamicTrailsEmitterData.

◆ RenderDebug()

void FDynamicRibbonEmitterData::RenderDebug ( const FParticleSystemSceneProxy Proxy,
FPrimitiveDrawInterface PDI,
const FSceneView View,
bool  bCrosses 
) const
virtual

Debug rendering

Parameters
ProxyThe primitive scene proxy for the emitter.
PDIThe primitive draw interface to render with
ViewThe scene view being rendered
bCrossesIf true, render Crosses at particle position; false, render points

Reimplemented from FDynamicTrailsEmitterData.

Member Data Documentation

◆ RenderAxisOption

uint32 FDynamicRibbonEmitterData::RenderAxisOption

The sprite particle data.

◆ Source

FDynamicRibbonEmitterReplayData FDynamicRibbonEmitterData::Source

The frame source data for this particle system. This is everything needed to represent this this particle system frame. It does not include any transient rendering thread data. Also, for non-simulating 'replay' particle systems, this data may have come straight from disk!


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