Particles

Particles module API reference: 19 headers · 60 types · 740 symbols.

Generated from particles.json · Oct 31, 2026Version 1.0.0
Build name
MowoEngine.Particles
Source
Engine/Source/Runtime/Particles/Public
Category
Runtime
Contents
19 headers · 60 types · 740 symbols

Particles/Components/ParticleEmitterComponent.h

KindTypeSummary
structParticleEmitterComponent

Particles/GPUParticle.h

KindTypeSummary
structGPUParticleGPU particle data (64 bytes, matches CPU Particle layout for easy upload)
structalignasSimulation constants (padded to 512 bytes for root CBV alignment)

Free functions

SignatureDescription
static_assert(offsetof(GPUParticleSimParams, emitterPosX) == 272, "GPUParticleRender.hlsl reads emitterPos at 272")GPUParticleRender.hlsl declares only the emitter position and the lighting block, with float4 padding between; these pin the offsets it assumes.
static_assert(offsetof(GPUParticleSimParams, toLightX) == 624, "GPUParticleRender.hlsl reads the lighting block at 624")
static_assert(sizeof(GPUParticleSimParams) == 768, "GPUParticleSimParams must stay 768 bytes")
static_assert(sizeof(GPUParticle) == 64, "GPUParticle must be 64 bytes")

Particles/GPUParticleRenderer.h

KindTypeSummary
structGPURenderEmitterParamsPer-emitter render state fed to the GPU billboard pass. Mirrors the CPU path's per-emitter knobs so a given billboard mode renders the same whichever simulationMode the emitter selects.
classGPUParticleRendererAbstract GPU particle renderer interface Manages compute simulation + billboard rendering for GPU-driven particle emitters.
structGPUParticleRenderer::EmitterStateBase class for per-emitter GPU state (RHIGPUParticleRenderer derives from this)

Particles/Particle.h

KindTypeSummary
structParticleParticle data: the 64 built-in bytes plus four custom attributes.
structParticleVertexVertex format for GPU rendering (32 bytes)
enumEmitterShape
enumBillboardMode
enumParticleBlendMode
enumParticleRenderMode
enumParticleShadingMode
enumParticleSimulationMode
structParticleColorKeyColor gradient key for particles (different from LineRenderer's ColorKey)
structParticleSizeKey
classFParticleCurves

Particles/ParticleCollision.h

KindTypeSummary
enumParticleCollisionModeWhich scene representation a collision module resolves against.
classParticleCollisionFieldOne frame's view of the scene as something particles can hit.

Particles/ParticleExpression.h

KindTypeSummary
classFParticleExpressionA per-particle script, the Niagara scratch-pad analogue: statements of the form vel.y = vel.y - 9.8 * dt (also += -= *= /=), separated by newlines or semicolons, compiled once into stack bytecode and run for every part
enumFParticleExpression::EOpThe GPU interpreter switches on these values; do not reorder.
structFParticleExpression::FInstr
structFParticleExpression::FContext

Particles/ParticleFogInputs.h

KindTypeSummary
structFParticleFogInputsWhat a particle fragment is fogged through (Shaders/Private/Particles/ ParticleFog.hlsli): the froxel volume, the sky atmosphere's constants, aerial volume and LUTs, and the frame's fog parameters. The renderer that owns
structFParticleFogParamsThe layout of FParticleFogInputs::Params (ParticleFogData in the shader).

Free functions

SignatureDescription
static_assert(sizeof(FParticleFogParams) == 112, "FParticleFogParams must match ParticleFogData in ParticleFog.hlsli")

Particles/ParticleModule.h

KindTypeSummary
enumEParticleEventTypeWhat a parent emitter's particle did this frame, for its sub-emitters.
structFParticleEventWhere and how: the child spawns at the position, may inherit a share of the velocity and the colour.
classParticleModuleBase interface for particle modules
classShapeModuleShape module - controls initial spawn position and direction
classVelocityModuleVelocity module - adds velocity over lifetime
classColorModuleColor module - interpolates color over lifetime
classSizeModuleSize module - interpolates size over lifetime
classForceModuleForce module - applies gravity and drag
classNoiseModuleNoise module - adds turbulence via simplex noise
classRotationModuleRotation module - controls rotation over lifetime
classCollisionModuleCollision module - bounces particles off the scene
classLightModuleLight module - the emitter's brightest particles become dynamic point lights that illuminate the scene. The module owns no per-particle state; it is a budgeted marker the renderer reads (see Scene::SubmitParticleLights)
classExpressionModulePer-particle script (FParticleExpression): the author's own math at spawn or every update, where the fixed modules run out — a spiral, a colour that follows speed, a size pulse. A spawn script runs on the CPU for both si
classSubEmitterModuleSub-emitter: wherever the parent's particles are born, die or hit something, spawn particles into a child emitter — sparks that burst into embers on impact, a firework shell that dies into a shower. The child is either a

Free functions

SignatureDescription
static constexpr uint32_t kParticleEventTypeCount = 3

Particles/ParticleModuleSerializer.h

KindTypeSummary
classFParticleModuleSerializerSingle source of truth for the MDF representation of a ParticleModule. Both the property-authored .particle asset and the graph-authored .vfx compiler route through here, so a module authored in either front-end serializ

Particles/ParticlePool.h

KindTypeSummary
classParticleRandomRandom number generator utilities for particle emission
classParticlePoolParticle pool with swap-remove for O(1) particle death

Particles/ParticleRenderer.h

KindTypeSummary
structParticleDrawBatchOne draw's worth of billboards: everything that has to agree between two particles for them to share a draw call. Batches are kept in submission order so an emitter sorted back-to-front stays back-to-front on screen.
classParticleRendererAbstract CPU particle renderer interface. The concrete backend (RHIParticleRenderer) is implemented on the Platform/ RHI API (Shader/Pipeline/VertexBuffer/DescriptorSet) and draws into an off-screen target via SetTargetF
structParticleRenderer::FQuadSpanA run of quads in the current batch, sized up front so emitters can fill their own runs on worker threads: reserving moves the batch vectors and writing never does, so every reservation of a frame comes before any write.

Particles/ParticleSystem.h

KindTypeSummary
classParticleSystem
structParticleSystem::GpuCollisionFieldParamsThe renderer's collision field expressed as GPU-samplable parameters, pushed once per view. Baked into every GPU emitter's sim params so the compute pass collides against the same SDF/depth the CPU CollisionModule uses (

Particles/RHIGPUParticleRenderer.h

KindTypeSummary
classRHIGPUParticleRenderer
structRHIGPUParticleRenderer::EmitterGPUStateConcrete emitter state

Particles/RHIParticleRenderer.h

KindTypeSummary
classRHIParticleRenderer

Particles/RHIRibbonRenderer.h

KindTypeSummary
classRHIRibbonRenderer

Particles/VfxEmitterConfig.h

KindTypeSummary
structFVfxEmitterConfigThe result of compiling a .vfx graph: the exact authorable emitter state the ParticleSystem consumes (the module list plus the spawn/lifetime/start/render settings). This mirrors the fields a property-authored ParticleAs

Particles/VfxGraph.h

KindTypeSummary
enumEVfxStageAuthoring stage a node belongs to. Purely a layout/grouping concern for the editor's stage columns; the compiler collects nodes by ModuleType, not Stage.
structFVfxGraphNodeOne node in a .vfx emitter graph. ModuleType is either a settings marker ("Emitter", "SpawnRate", "Burst", "Initialize", "Render") or a particle module type name ("Shape", "Velocity", "Color", "Size", "Force", "Noise", "
structFVfxGraphConnection
classFVfxGraphThe particle-attribute flow authored as a node graph. Stores the nodes, their connections and their per-node parameter blobs, and serializes the whole thing to a .vfx MDF document. Compilation to a runtime emitter config

Particles/VfxGraphCompiler.h

KindTypeSummary
classFVfxGraphCompilerTurns a .vfx node graph into the runtime emitter config the ParticleSystem consumes, and back. Compile walks the settings nodes into the config fields and each module node (in graph order) into a ParticleModule via the s

Renderer/RibbonRenderer.h

KindTypeSummary
structRibbonVertex
structRibbonSegmentRibbon segment data (generated from line points)
classRibbonRendererAbstract ribbon (trail-strip) renderer interface. The concrete backend (RHIRibbonRenderer) is implemented on the Platform/ RHI API and draws into an off-screen target set before Initialize.

Page feedback

Was this page helpful?