SDL_AUDIO_FRAMESIZE(3)

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

✨ SDL_AUDIO_FRAMESIZE(3) — the SDL3 functions page, bestie edition ✨

okay so you're in the SDL3 FUNCTIONS corner of the manual and you clicked on SDL_AUDIO_FRAMESIZE 💖 buckle up, this one is tiny but it's lowkey carrying the whole audio pipeline on its back.

🌸 NAME 🌸

SDL_AUDIO_FRAMESIZE — calculate the size of each audio frame (in bytes) from an SDL_AudioSpec.

like. one frame. how many bytes. that's the whole assignment. 💅

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_audio.h>

#define SDL_AUDIO_FRAMESIZE(x) (SDL_AUDIO_BYTESIZE((x).format) * (x).channels)

it's a macro, not a function, so there's no linking drama, no ABI nonsense, it just inlines itself into your soul at compile time. iconic behavior fr fr ✨

🦋 DESCRIPTION 🦋

This reports on the size of an audio sample frame: stereo Sint16 data (2 channels of 2 bytes each) would be 4 bytes per frame, for example.

so it's doing the math for you: how many bytes does one single sample frame eat up, given the format and the channel count. 2 channels × 2 bytes = 4 bytes per frame, and the macro just. knows. it's giving "she did the math so you don't have to" 🧮💅

🍓 MACRO PARAMETERS 🍓

  • x — an SDL_AudioSpec to query. that's it, that's the whole input list. hand her your spec and she'll tell you the frame size. 🫶

👑 RETURN VALUE 👑

Returns the number of bytes used per sample frame.

no error code, no -1, no NULL check, no drama. just bytes. 🌈

💜 THREAD SAFETY 💜

It is safe to call this macro from any thread.

bestie you can call this from literally any thread, it does not care, it has no state, it is at peace. 🧘‍♀️✨

⭐ AVAILABILITY ⭐

This macro is available since SDL 3.2.0.

if you're on anything older, sorry babe, this macro does not exist yet 😭 go upgrade.

and that's the whole page!! no SEE ALSO, no bugs section, no warnings — just a very well-behaved little macro that minds its own business 💖

this was brought to you by Simple Directmedia Layer, page version SDL 3.4.18 — stay hydrated, read your manpages, and may your audio frames always be exactly the size you expected 🎀🦋💅

📦 where this page comes from