class

ParticleAsset

ParticleAsset stores particle effect configuration. Load() parses a .mparticle MDF file. Modules are created based on [[modules]] array entries.

Module
AssetSystem
Header
#include "AssetSystem/Assets/ParticleAsset.h"
Namespace
Mowo

Constructors

SignatureNameDescription
ParticleAsset()ParticleAsset
~ParticleAsset() override~ParticleAsset

Public functions

ReturnsNameDescription
boolLoadAsset interface
voidUnload
boolCreateGPU
voidDestroyGPU
boolDestroyGPUIsFrameSafe
boolSaveToFile
std::stringSerializeToString
boolLoadFromString
voidCollectDependencyIDs
voidCollectDependencyPaths
const std::string&GetNameBasic settings
floatGetDuration
boolIsLooping
boolGetPlayOnAwake
floatGetEmissionRateEmission
uint32_tGetMaxParticles
intGetBurstCount
floatGetLifetimeMinLifetime
floatGetLifetimeMax
Vec3GetStartVelocityStart values
floatGetStartSpeedMin
floatGetStartSpeedMax
Vec2GetStartSizeMin
Vec2GetStartSizeMax
Vec4GetStartColor
BillboardModeGetBillboardModeRendering
ParticleBlendModeGetBlendMode
boolGetDepthTest
UUIDGetTextureID
ParticleSimulationModeGetSimulationMode
floatGetVelocityStretch
floatGetStretchMax
ParticleRenderModeGetRenderMode
const std::string&GetMeshPath
const std::string&GetMeshType
ParticleShadingModeGetShadingMode
const std::vector<Scope<ParticleModule>>&GetModulesModules
std::vector<Scope<ParticleModule>>&GetModulesMutable access for the particle editor — the editor authors the module set in place, then persists it through SaveToFile.
ParticleModule*AddModule
voidRemoveModuleAt
voidClearModules
voidCloneModulesToClone modules for emitter component
voidApplyToPush every authored field onto an emitter.
voidToEmitterConfigFlatten the asset into the neutral emitter config the VFX graph compiler also targets.
voidSetName
voidSetDuration
voidSetLoop
voidSetPlayOnAwake
voidSetEmissionRate
voidSetMaxParticles
voidSetBurstCount
voidSetLifetime
voidSetStartVelocity
voidSetStartSpeed
voidSetStartSize
voidSetStartColor
voidSetBillboardMode
voidSetBlendMode
voidSetDepthTest
voidSetTextureID
voidSetSimulationMode
voidSetVelocityStretch
voidSetStretchMax
voidSetRenderMode
voidSetMeshPath
voidSetMeshType
voidSetShadingMode

Function details

ParticleAsset

C++
ParticleAsset()

~ParticleAsset

C++
~ParticleAsset() override

Load

C++
bool Load(const std::string& path) override

Asset interface

Unload

C++
void Unload() override

CreateGPU

C++
bool CreateGPU(const GPUContext& ctx) override

DestroyGPU

C++
void DestroyGPU() override

DestroyGPUIsFrameSafe

C++
bool DestroyGPUIsFrameSafe() const override

SaveToFile

C++
bool SaveToFile(const std::string& path) const

SerializeToString

C++
std::string SerializeToString() const

LoadFromString

C++
bool LoadFromString(const std::string& source)

CollectDependencyIDs

C++
void CollectDependencyIDs(std::vector<UUID>& out) const override

CollectDependencyPaths

C++
void CollectDependencyPaths(std::vector<std::string>& out) const override

GetName

C++
const std::string& GetName() const

Basic settings

GetDuration

C++
float GetDuration() const

IsLooping

C++
bool IsLooping() const

GetPlayOnAwake

C++
bool GetPlayOnAwake() const

GetEmissionRate

C++
float GetEmissionRate() const

Emission

GetMaxParticles

C++
uint32_t GetMaxParticles() const

GetBurstCount

C++
int GetBurstCount() const

GetLifetimeMin

C++
float GetLifetimeMin() const

Lifetime

GetLifetimeMax

C++
float GetLifetimeMax() const

GetStartVelocity

C++
Vec3 GetStartVelocity() const

Start values

GetStartSpeedMin

C++
float GetStartSpeedMin() const

GetStartSpeedMax

C++
float GetStartSpeedMax() const

GetStartSizeMin

C++
Vec2 GetStartSizeMin() const

GetStartSizeMax

C++
Vec2 GetStartSizeMax() const

GetStartColor

C++
Vec4 GetStartColor() const

GetBillboardMode

C++
BillboardMode GetBillboardMode() const

Rendering

GetBlendMode

C++
ParticleBlendMode GetBlendMode() const

GetDepthTest

C++
bool GetDepthTest() const

GetTextureID

C++
UUID GetTextureID() const

GetSimulationMode

C++
ParticleSimulationMode GetSimulationMode() const

GetVelocityStretch

C++
float GetVelocityStretch() const

GetStretchMax

C++
float GetStretchMax() const

GetRenderMode

C++
ParticleRenderMode GetRenderMode() const

GetMeshPath

C++
const std::string& GetMeshPath() const

GetMeshType

C++
const std::string& GetMeshType() const

GetShadingMode

C++
ParticleShadingMode GetShadingMode() const

GetModules

C++
const std::vector<Scope<ParticleModule>>& GetModules() const

Modules

GetModules

C++
std::vector<Scope<ParticleModule>>& GetModules()

Mutable access for the particle editor — the editor authors the module set in place, then persists it through SaveToFile.

AddModule

C++
ParticleModule* AddModule(Scope<ParticleModule> module)

RemoveModuleAt

C++
void RemoveModuleAt(size_t index)

ClearModules

C++
void ClearModules()

CloneModulesTo

C++
void CloneModulesTo(std::vector<Scope<ParticleModule>>& target) const

Clone modules for emitter component

ApplyTo

C++
void ApplyTo(ParticleEmitterComponent& emitter) const

Push every authored field onto an emitter. The asset is the authoring surface, so what a designer sets in the particle editor is what plays; fields the asset does not cover (seed, sub-UV, soft fade, cull distance) stay component-authored.

ToEmitterConfig

C++
void ToEmitterConfig(struct FVfxEmitterConfig& config) const

Flatten the asset into the neutral emitter config the VFX graph compiler also targets. This is the bridge that lets a property-authored emitter be represented as a graph (config -> FVfxGraphCompiler::BuildGraph).

SetName

C++
void SetName(const std::string& name)

SetDuration

C++
void SetDuration(float duration)

SetLoop

C++
void SetLoop(bool loop)

SetPlayOnAwake

C++
void SetPlayOnAwake(bool play)

SetEmissionRate

C++
void SetEmissionRate(float rate)

SetMaxParticles

C++
void SetMaxParticles(uint32_t max)

SetBurstCount

C++
void SetBurstCount(int count)

SetLifetime

C++
void SetLifetime(float min, float max)

SetStartVelocity

C++
void SetStartVelocity(const Vec3& vel)

SetStartSpeed

C++
void SetStartSpeed(float min, float max)

SetStartSize

C++
void SetStartSize(const Vec2& min, const Vec2& max)

SetStartColor

C++
void SetStartColor(const Vec4& color)

SetBillboardMode

C++
void SetBillboardMode(BillboardMode mode)

SetBlendMode

C++
void SetBlendMode(ParticleBlendMode mode)

SetDepthTest

C++
void SetDepthTest(bool test)

SetTextureID

C++
void SetTextureID(UUID id)

SetSimulationMode

C++
void SetSimulationMode(ParticleSimulationMode mode)

SetVelocityStretch

C++
void SetVelocityStretch(float stretch)

SetStretchMax

C++
void SetStretchMax(float max)

SetRenderMode

C++
void SetRenderMode(ParticleRenderMode mode)

SetMeshPath

C++
void SetMeshPath(const std::string& path)

SetMeshType

C++
void SetMeshType(const std::string& type)

SetShadingMode

C++
void SetShadingMode(ParticleShadingMode mode)
Generated from AssetSystem/Assets/ParticleAsset.h via assetsystem.json · Nov 4, 2026Version 1.0.0