Epok Engine

EPOK RUNTIME

epok::instrument::valid_envelope

Function · 1 overload

Function

Performs `valid envelope` as part of the instrument bank module.

Belongs to
epok::instrument
Header
instrument_bank.hpp
Overloads
1

Declaration

Declaration
inline bool valid_envelope(const Envelope& e, bool volume)

Performs `valid envelope` as part of the instrument bank module.

ParameterTypeMeaning
econst Envelope &Value supplied for e. Keep referenced or pointed-to data valid for the complete call.
volumeboolValue supplied for volume. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "instrument_bank.hpp"

// Assume these named values have been initialized with valid data:
// const Envelope & e
// bool volume

auto result = epok::instrument::valid_envelope(e, volume);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/instrument_bank.hpp:40

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function templateaabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function templateaabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Functionaabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Functionaabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Functionaabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Functionactivate_texture_bankPerforms `activate texture bank` as part of the epok module.Functionactive_cameraPerforms `active camera` as part of the epok module.Functionactor_for_slotPerforms `actor for slot` as part of the actor tables module.Functionallocate_actor_dataPerforms `allocate actor data` as part of the epok module.Functionattach_componentSpatial attachment between components of the same domain.Functionaudio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function