Epok Engine

EPOK RUNTIME

epok::effects::Pool::spawn

Method · 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.

Method

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

Belongs to
epok::effects::Pool
Header
particle_effect_runtime.hpp
Overloads
1

Declaration

Declaration
Handle spawn(const Asset& asset,const Affine<Fixed>& world,uint32_t scene, const timeline::BoundTarget* external=nullptr,DataHandle owner={},uint32_t seed=0,LayerInitializer initialize=nullptr)

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

ParameterTypeMeaning
assetconst Asset &Not documented; consult the linked header.
worldconst Affine<Fixed> &Not documented; consult the linked header.
sceneuint32_tNot documented; consult the linked header.
externalconst timeline::BoundTarget *Not documented; consult the linked header.
ownerDataHandleNot documented; consult the linked header.
seeduint32_tNot documented; consult the linked header.
initializeLayerInitializerNot documented; consult the linked header.

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

Example sketch

C++ example
#include "particle_effect_runtime.hpp"

// Assume these named values have been initialized with valid data:
// const Asset & asset
// const Affine<Fixed> & world
// uint32_t scene
// const timeline::BoundTarget * external
// DataHandle owner
// uint32_t seed
// LayerInitializer initialize

epok::effects::Pool& object = /* obtain a valid instance */;

auto result = object.spawn(asset, world, scene, external, owner, seed, initialize);

Trade-offs and warnings

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

Declared in runtime/particle_effect_runtime.hpp:83

Related members