Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

SoundManagerMsg Struct Reference

#include <SoundManagerMsg.h>

List of all members.


Detailed Description

A small header that preceeds data sent by SoundManager between processes.

Definition at line 8 of file SoundManagerMsg.h.

Private Types

typedef unsigned short Snd_ID
 the type to use when referring to Sounds
enum  MsgType { add, del, wakeup, unknown }
 Denotes what type of message this is. More...

Private Member Functions

 SoundManagerMsg ()
 constructor
virtual ~SoundManagerMsg ()
 virtual destructor
Snd_ID getID () const
 Accessor for the id number, set by SoundManager.
void setAdd (Snd_ID sndid, unsigned int sndsn)
 Sets up the header as an add message.
void setDelete (RCRegion *rcregion)
 Sets up the header as an erase message.
void setWakeup ()
 Sets up the header as a wakeup message.
 SoundManagerMsg (const SoundManagerMsg &)
 don't call
SoundManagerMsg operator= (const SoundManagerMsg &)
 don't call

Private Attributes

enum SoundManagerMsg::MsgType type
 Denotes what type of message this is.
Snd_ID id
 The id of the sound this is in reference to.
RCRegion * region
 The RCRegion to free, if it's a deletion.
unsigned int sn
 The serial number of the sound this is in reference to, see SoundManager::sn.

Friends

class SoundManager


Member Typedef Documentation

typedef unsigned short SoundManagerMsg::Snd_ID [private]
 

the type to use when referring to Sounds

Definition at line 13 of file SoundManagerMsg.h.


Member Enumeration Documentation

enum SoundManagerMsg::MsgType [private]
 

Denotes what type of message this is.

Enumerator:
add 
del 
wakeup 
unknown 

Definition at line 16 of file SoundManagerMsg.h.


Constructor & Destructor Documentation

SoundManagerMsg::SoundManagerMsg  )  [inline, private]
 

constructor

Definition at line 28 of file SoundManagerMsg.h.

virtual SoundManagerMsg::~SoundManagerMsg  )  [inline, private, virtual]
 

virtual destructor

doesn't do anything, but don't remove it, otherwise this would no longer be a virtual base class

Definition at line 32 of file SoundManagerMsg.h.

SoundManagerMsg::SoundManagerMsg const SoundManagerMsg  )  [private]
 

don't call


Member Function Documentation

Snd_ID SoundManagerMsg::getID  )  const [inline, private]
 

Accessor for the id number, set by SoundManager.

Definition at line 35 of file SoundManagerMsg.h.

Referenced by SoundManager::LoadBuffer().

SoundManagerMsg SoundManagerMsg::operator= const SoundManagerMsg  )  [private]
 

don't call

void SoundManagerMsg::setAdd Snd_ID  sndid,
unsigned int  sndsn
[inline, private]
 

Sets up the header as an add message.

Definition at line 38 of file SoundManagerMsg.h.

Referenced by SoundManager::LoadBuffer().

void SoundManagerMsg::setDelete RCRegion *  rcregion  )  [inline, private]
 

Sets up the header as an erase message.

Definition at line 45 of file SoundManagerMsg.h.

void SoundManagerMsg::setWakeup  )  [inline, private]
 

Sets up the header as a wakeup message.

Definition at line 51 of file SoundManagerMsg.h.


Friends And Related Function Documentation

friend class SoundManager [friend]
 

Definition at line 10 of file SoundManagerMsg.h.


Member Data Documentation

Snd_ID SoundManagerMsg::id [private]
 

The id of the sound this is in reference to.

Definition at line 19 of file SoundManagerMsg.h.

Referenced by getID(), and SoundManager::ProcessMsg().

RCRegion* SoundManagerMsg::region [private]
 

The RCRegion to free, if it's a deletion.

Definition at line 22 of file SoundManagerMsg.h.

Referenced by SoundManager::ProcessMsg().

unsigned int SoundManagerMsg::sn [private]
 

The serial number of the sound this is in reference to, see SoundManager::sn.

Definition at line 25 of file SoundManagerMsg.h.

Referenced by SoundManager::ProcessMsg(), and setAdd().

enum SoundManagerMsg::MsgType SoundManagerMsg::type [private]
 

Denotes what type of message this is.

Referenced by SoundManager::ProcessMsg(), setAdd(), setDelete(), and setWakeup().


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

Tekkotsu v2.4.1
Generated Tue Aug 16 16:35:09 2005 by Doxygen 1.4.4