The parameters to play a sound. More...

#include <RageSound.h>

Collaboration diagram for RageSoundParams:

Public Types
enum	StopMode_t { M_STOP , M_LOOP , M_CONTINUE , M_AUTO }
	How does the sound stop itself, if it does? More...

Public Attributes
float	m_StartSecond { 0 }

float	m_LengthSeconds { -1 }

float	m_fFadeInSeconds { 0 }

float	m_fFadeOutSeconds { 0 }

float	m_Volume { 1.0F }

float	m_fAttractVolume { 1.0F }

float	m_fPitch { 1.0F }

float	m_fSpeed { 1.0F }

bool	m_bAccurateSync { false }

RageTimer	m_StartTime

enum RageSoundParams::StopMode_t	M_AUTO
	How does the sound stop itself, if it does?

bool	m_bIsCriticalSound { false }

bool	m_bIsAction { false }

bool	m_bIsBGM { false }

Detailed Description

The parameters to play a sound.

These are normally changed before playing begins, and are constant from then on.

Member Enumeration Documentation

How does the sound stop itself, if it does?

Enumerator
M_STOP	The sound is stopped at the end.
M_LOOP	The sound restarts itself.
M_CONTINUE	Silence is fed at the end to continue timing longer than the sound.
M_AUTO	The default, the sound stops while obeying filename hints.

The documentation for this struct was generated from the following files: