Epok Engine

EPOK RUNTIME

epok::music_retains_audio_source

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

Component-owned AudioSource storage stays quarantined while the XA consumer still points at it -- exactly the rule allocate_actor_data (runtime/lifecycle.hpp) applies to a legacy slot's `audio`.

Belongs to
epok
Header
scene_service.hpp
Overloads
1

Declaration

Declaration
inline bool music_retains_audio_source(const AudioSource* source)

Component-owned AudioSource storage stays quarantined while the XA consumer still points at it -- exactly the rule allocate_actor_data (runtime/lifecycle.hpp) applies to a legacy slot's `audio`.

ParameterTypeMeaning
sourceconst AudioSource *Not documented; consult the linked header.

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

Example sketch

C++ example
#include "scene_service.hpp"

// Assume these named values have been initialized with valid data:
// const AudioSource * source

auto result = epok::music_retains_audio_source(source);

Trade-offs and warnings

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

Declared in runtime/scene_service.hpp:14

Related members