NAME¶

MIX_SetTrackGain - Set a track's gain control.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

bool MIX_SetTrackGain(MIX_Track *track, float gain);

DESCRIPTION¶

Each track has its own gain, to adjust its overall volume. Each sample from this track is modulated by this gain value. A gain of zero will generate silence, 1.0f will not change the mixed volume, and larger than 1.0f will increase the volume. Negative values are illegal. There is no maximum gain specified, but this can quickly get extremely loud, so please be careful with this setting.

A track's gain defaults to 1.0f.

This value can be changed at any time to adjust the future mix.

FUNCTION PARAMETERS¶

track

the track to adjust.

gain

the new gain value.

RETURN VALUE¶

Returns true on success or false on failure; call SDL_GetError() for more information.

THREAD SAFETY¶

It is safe to call this function from any thread.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.

SEE ALSO¶

•(3), MIX_GetTrackGain(3), •(3), MIX_SetMasterGain(3)