NAME¶

SDL_DEFINE_AUDIO_FORMAT - Define an SDL_AudioFormat value.

SYNOPSIS¶

#include <SDL3/SDL_audio.h>

#define SDL_DEFINE_AUDIO_FORMAT(signed, bigendian, flt, size) \
    (((Uint16)(signed) << 15) | ((Uint16)(bigendian) << 12) | ((Uint16)(flt) << 8) | ((size) & SDL_AUDIO_MASK_BITSIZE))

DESCRIPTION¶

SDL does not support custom audio formats, so this macro is not of much use externally, but it can be illustrative as to what the various bits of an SDL_AudioFormat mean.

For example, SDL_AUDIO_S32LE looks like this:

SDL_DEFINE_AUDIO_FORMAT(1, 0, 0, 32)
    

MACRO PARAMETERS¶

signed

1 for signed data, 0 for unsigned data.

bigendian

1 for bigendian data, 0 for littleendian data.

flt

1 for floating point data, 0 for integer data.

size

number of bits per sample.

RETURN VALUE¶

Returns a format value in the style of SDL_AudioFormat.

THREAD SAFETY¶

It is safe to call this macro from any thread.

AVAILABILITY¶

This macro is available since SDL 3.2.0.