Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

SoundInit Struct Reference

2D sound initialization structure. More...

#include <IAudio.h>

List of all members.

Public Methods

 SoundInit ()
void Clear ()

Public Attributes

std::string m_sFileName
 The file from which to load the sound data.

bool m_bStreaming
 Should the file be incrementally streamed from the disk?

bool m_bLooping
 Should the sound be continously looped?

bool m_bMusic
 Is this music?

uint32 m_nPriority
 User-defined sound priority setting. More...

SoundProp m_Prop
 Used to set the initial properties of the sound. More...


Detailed Description

2D sound initialization structure.

Initialization structure for the 2D ISound class. All initial parameters can be set in this structure. Generally speaking, parameters listed in this structure are crucial to the initial contruction of the sound object, and so cannot be modified at run-time.

See also:
ISound::Init()


Constructor & Destructor Documentation

SoundInit::SoundInit ( ) [inline]
 

SoundInit constructor automatically calls Clear() to initialize the structure.


Member Function Documentation

void SoundInit::Clear ( ) [inline]
 

Sets all members either to an appropriate default value if it exists, or else to zero.


Member Data Documentation

SoundProp SoundInit::m_Prop
 

Used to set the initial properties of the sound.

All values in in SoundProp can also be set at run-time

See also:
SoundProp

uint32 SoundInit::m_nPriority
 

User-defined sound priority setting.

This value is used (among other determinations) when deciding which sound should be discarded if the buffer limit is reached.


The documentation for this struct was generated from the following file:
Generated at Sun Jul 28 23:17:43 2002 for GAP Audio System by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001