adjust_sample(3alleg4)

📦 version 4.4.3.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 adjust_sample — bestie edition 💖

ok so like. this is a page from the Allegro manual (section 3alleg4), and today we're talking about adjust_sample, which is genuinely one of the most iconic little functions in the whole Allegro game programming library. no cap.

✨ NAME ✨

adjust_sample — alters the parameters of a sample while it is playing. 🎧

she's from the Allegro game programming library, and she's here to let you mess with a sound mid-playback. it's giving DJ booth energy, fr fr.

🌸 SYNOPSIS 🌸

#include <allegro.h>

void adjust_sample(const SAMPLE *spl, int vol, int pan, int freq, int loop);

look at her. five arguments. a whole vibe. 💅

🦋 DESCRIPTION 🦋

okay so here's the tea: adjust_sample alters the parameters of a sample while it is playing. which is so useful for manipulating looped sounds — like, the loop is going, the loop is vibing, and you just reach in and change stuff. main character energy tbh.

here's what you can tweak mid-flight:

  • the volume 🔥
  • the pan 🌈
  • the frequency ⭐
  • and you can also clear the loop flag — which will stop the sample when it next reaches the end of its loop 👑

and bestie, the values of the parameters are just like those of play_sample(). same energy, same rules, no new lore to memorize. 🫶

⚠️ okay important: if there are several copies of the same sample playing, this will adjust the first one it comes across. so like, whichever one it bumps into first. no choosing, no picking favourites, it just grabs the first. 🙈
💀 and if the sample is not playing, it has no effect. literally nothing happens. the function just shrugs and moves on. don't come for her, she warned you.

👑 SEE ALSO 👑

go read these next, they're all part of the same friend group:

and that's the whole page bestie!! now go make some sounds go brrr 🎀✨

mwah 💋 — this was Allegro, version 4.4.3, and yes the manual page is literally titled adjust_sample(3alleg4) because she's that girl. bye!! 🦋💖

📦 where this page comes from