ALLEGRO_SAMPLE_INSTANCE(3)

💅 ALLEGRO_SAMPLE_INSTANCE (3) 💅

okay so bestie, welcome to the Allegro reference manual, section 3 of the Library Functions Manual — this is the ALLEGRO_SAMPLE_INSTANCE page and it's genuinely so iconic, let me tell you everything 🫶

---

✨ NAME ✨

ALLEGRO_SAMPLE_INSTANCE — the Allegro 5 API legend itself 👑

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro_audio.h>

typedef struct ALLEGRO_SAMPLE_INSTANCE ALLEGRO_SAMPLE_INSTANCE;

like, that's the whole vibe check right there 💖

---

🦋 DESCRIPTION 🦋

so an ALLEGRO_SAMPLE_INSTANCE object represents a playable instance of a predefined sound effect — think of it as the main character version of a sound, ready to be played ✨

it holds all the info about how the effect should be played. these playback parameters consist of:

• the looping mode 🔁
• loop start/end points 📍
• playing position 🎯
• speed ⚡
• gain 🔊
• pan ↔️
• the playmode 🎮

and ngl, whether a sample instance is currently playing or paused is also one of its properties — it's giving multitasking queen 💅

an instance uses the data from an ALLEGRO_SAMPLE(3) object, iykyk. multiple instances may be created from the same ALLEGRO_SAMPLE — no cap, you can absolutely clone the vibe 🌈

⚠️ okay so this part is IMPORTANT bestie: an ALLEGRO_SAMPLE must not be destroyed while there are instances which reference it. like, do NOT come for that sample while its instances are still out here living their lives 😭💀

and here's the tea — to actually produce audio output, an ALLEGRO_SAMPLE_INSTANCE must be attached to an ALLEGRO_MIXER(3) which eventually reaches an ALLEGRO_VOICE(3) object. it's a whole pipeline, a whole ecosystem, a whole chain of iconic-ness 🧚✨

---

👑 SEE ALSO 👑

• ALLEGRO_SAMPLE(3) — go read it, it's the source material fr fr 🍓

---

and that's the page, bestie!! mwah 💋 this was the Allegro reference manual doing its thing — periodt 🎀💜