Epok Engine

EPOK RUNTIME

epok::effects::spawn

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Performs `spawn` as part of runtime effects and their deterministic playback state.

Belongs to
epok::effects
Header
particle_effect_service.hpp
Overloads
1

Declaration

Declaration
inline Handle spawn(const Asset& asset,const Transform& transform,uint32_t seed=0,DataHandle owner={},const timeline::BoundTarget* bindings=nullptr)

Performs `spawn` as part of runtime effects and their deterministic playback state.

ParameterTypeMeaning
assetconst Asset &Not documented; consult the linked header.
transformconst Transform &Not documented; consult the linked header.
seeduint32_tNot documented; consult the linked header.
ownerDataHandleNot documented; consult the linked header.
bindingsconst timeline::BoundTarget *Not documented; consult the linked header.

Returns: Handle. Consult the linked header for its meaning.

Example sketch

C++ example
#include "particle_effect_service.hpp"

// Assume these named values have been initialized with valid data:
// const Asset & asset
// const Transform & transform
// uint32_t seed
// DataHandle owner
// const timeline::BoundTarget * bindings

auto result = epok::effects::spawn(asset, transform, seed, owner, bindings);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/particle_effect_service.hpp:44

Related members