audio_Music.hpp File Reference

Music (BGM) support. More...

#include <SDL2/SDL_mixer.h>
#include <pu/pu_Include.hpp>

Go to the source code of this file.

Namespaces
namespace	pu
namespace	pu::audio

Typedefs
using	pu::audio::Music = Mix_Music*
	Type representing a music file.

Functions
Music	pu::audio::OpenMusic (std::string &path)
	Opens a music file from the specified path.
void	pu::audio::PlayMusic (Music mus, i32 loops)
	Plays a music file.
void	pu::audio::PlayMusicWithFadeIn (Music mus, i32 loops, i32 ms)
	Plays a music file with a fade-in effect.
bool	pu::audio::IsPlayingMusic ()
	Checks if music is currently playing.
void	pu::audio::PauseMusic ()
	Pauses the currently playing music.
void	pu::audio::ResumeMusic ()
	Resumes the currently paused music.
void	pu::audio::SetMusicVolume (i32 vol)
	Sets the volume of the currently playing music.
i32	pu::audio::GetMusicVolume ()
	Gets the volume of the currently playing music.
void	pu::audio::FadeOutMusic (i32 ms)
	Fades out the currently playing music.
void	pu::audio::RewindMusic ()
	Rewinds the currently playing music.
void	pu::audio::StopMusic ()
	Stops the currently playing music.
void	pu::audio::SetMusicPosition (double sec)
	Sets the position of the currently playing music.
void	pu::audio::DestroyMusic (Music &mus)
	Destroys a music file.

Detailed Description

Music (BGM) support.

Plutonium library

Author

XorTroll

Copyright

XorTroll