SDL_LoadWAV(3)

📦
version 3.4.18 · 10 versions
, in fedora 43, fedora 44

✨ SDL_LoadWAV ✨

okay bestie, welcome to the <code>SDL_LoadWAV(3)</code> page — it's part of the SDL3 FUNCTIONS squad, and it's literally the "just gimme that WAV file" button you've been looking for. 💖

🌸 NAME 🌸

SDL_LoadWAV — loads a WAV from a file path. that's it, that's the whole vibe. 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_audio.h>

bool SDL_LoadWAV(const char *path, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len);

💅 DESCRIPTION 💅

so this one is a convenience function, which is a fancy way of saying it's the shortcut. it is effectively the same as doing this whole thing yourself:

SDL_LoadWAV_IO(SDL_IOFromFile(path, "rb"), true, spec, audio_buf, audio_len);

like, same energy, same result, just less typing on your part. you're welcome. 🫶

🎀 FUNCTION PARAMETERS 🎀

  • path — the file path of the WAV file you wanna open. yes, the path. the whole point. 🗺️
  • spec — a pointer to an SDL_AudioSpec that gets set to the WAVE data's format details on successful return. it's basically the receipt telling you what the audio actually looks like. 🧾
  • audio_buf — a pointer that gets filled with the audio data, and the function is the one who allocates it. not you. her. 💅
  • audio_len — a pointer that gets filled with the length of the audio data buffer, measured in bytes. 📏

👑 RETURN VALUE 👑

returns true on success, bestie. ✨ when that happens, audio_buf gets filled with a pointer to an allocated buffer holding the audio data, and audio_len gets filled with the length of that audio buffer in bytes. everything slays.

this function returns false if the .WAV file cannot be opened, uses an unknown data format, or is corrupt. in that case, call SDL_GetError() for more information. 😭 she'll tell you what went wrong, fr fr.

when your application is done with the data returned in audio_buf, it should call SDL_free() to dispose of it. no ghost buffers in this house, periodt. 🧹

🌈 THREAD SAFETY 🌈

it is safe to call this function from any thread. go off, multithreaded main character. 👑

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. if you're on anything older, sorry babe, she's not there yet. 🙈

💜 SEE ALSO 💜

and that's the whole page, gorgeous. this lil masterpiece comes to you from Simple Directmedia Layer, running SDL 3.4.18 — so go load a WAV, free your buffers, and hydrate. mwah. 💖🎀🦋✨

📦 where this page comes from