ScummVM API documentation
Public Member Functions | Protected Attributes | List of all members
hpl::iSoundData Class Referenceabstract
Inheritance diagram for hpl::iSoundData:
hpl::iResourceBase hpl::cOpenALSoundData

Public Member Functions

 iSoundData (tString asName, bool abStream)
 
virtual bool CreateFromFile (const tString &asFile)=0
 
virtual iSoundChannel * CreateChannel (int alPriority)=0
 
bool IsStream ()
 
void SetLoopStream (bool abX)
 
bool GetLoopStream ()
 
bool reload ()
 
void unload ()
 
void destroy ()
 
void SetSoundManager (cSoundManager *apSoundManager)
 
- Public Member Functions inherited from hpl::iResourceBase
 iResourceBase (tString asName, unsigned long alPrio)
 
tString GetName ()
 
unsigned long GetHandle ()
 
void SetHandle (unsigned long alHandle)
 
tString GetFilePath ()
 
unsigned long GetTime ()
 
unsigned long GetPrio ()
 
unsigned long GetSize ()
 
void SetLogDestruction (bool abX)
 
unsigned int GetUserCount ()
 
void IncUserCount ()
 
void DecUserCount ()
 
bool HasUsers ()
 

Protected Attributes

bool mbStream
 
bool mbLoopStream
 
cSoundManager * mpSoundManger
 
- Protected Attributes inherited from hpl::iResourceBase
unsigned int mlPrio
 
unsigned long mlTime
 
unsigned long mlSize
 
unsigned int mlUserCount
 
unsigned long mlHandle
 
tString msName
 
tString msFilePath
 
bool mbLogDestruction
 

Additional Inherited Members

- Static Public Member Functions inherited from hpl::iResourceBase
static bool GetLogCreateAndDelete ()
 
static void SetLogCreateAndDelete (bool abX)
 
- Static Protected Attributes inherited from hpl::iResourceBase
static bool mbLogCreateAndDelete
 

Member Function Documentation

◆ reload()

bool hpl::iSoundData::reload ( )
inlinevirtual

virtual bool Reload()=0;

Returns
true is reload was successful, else false.

Implements hpl::iResourceBase.

◆ unload()

void hpl::iSoundData::unload ( )
inlinevirtual

Free most the memory, save info to get started again.

Implements hpl::iResourceBase.

◆ destroy()

void hpl::iSoundData::destroy ( )
inlinevirtual

Free all memory.

Implements hpl::iResourceBase.

The documentation for this class was generated from the following file: