Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members | Related Pages | Search

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.

Public Types

typedef unsigned short Snd_ID
 the type to use when referring to Sounds


Public Member Functions

 SoundManagerMsg ()
 constructor

virtual ~SoundManagerMsg ()
 virtual destructor

Snd_ID getID () const
 Accessor for the id number, set by SoundManager.


Static Public Attributes

const unsigned int MSG_SIZE = 16
 maintains even word alignment


Private Types

enum  MsgType { add, del, wakeup, unknown }
 Denotes what type of message this is. More...


Private Member Functions

void setAdd (Snd_ID sndid)
 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.


Friends

class SoundManager


Member Typedef Documentation

typedef unsigned short SoundManagerMsg::Snd_ID
 

the type to use when referring to Sounds

Definition at line 10 of file SoundManagerMsg.h.


Member Enumeration Documentation

enum SoundManagerMsg::MsgType [private]
 

Denotes what type of message this is.

Enumeration values:
add 
del 
wakeup 
unknown 

Definition at line 28 of file SoundManagerMsg.h.


Constructor & Destructor Documentation

SoundManagerMsg::SoundManagerMsg  )  [inline]
 

constructor

Definition at line 15 of file SoundManagerMsg.h.

References id, region, Snd_ID, type, and unknown.

virtual SoundManagerMsg::~SoundManagerMsg  )  [inline, 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 19 of file SoundManagerMsg.h.

SoundManagerMsg::SoundManagerMsg const SoundManagerMsg  )  [private]
 

don't call


Member Function Documentation

Snd_ID SoundManagerMsg::getID  )  const [inline]
 

Accessor for the id number, set by SoundManager.

Definition at line 22 of file SoundManagerMsg.h.

References id, and Snd_ID.

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

don't call

void SoundManagerMsg::setAdd Snd_ID  sndid  )  [inline, private]
 

Sets up the header as an add message.

Definition at line 37 of file SoundManagerMsg.h.

References add, id, and type.

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

Sets up the header as an erase message.

Definition at line 43 of file SoundManagerMsg.h.

References del, region, and type.

void SoundManagerMsg::setWakeup  )  [inline, private]
 

Sets up the header as a wakeup message.

Definition at line 49 of file SoundManagerMsg.h.

References type, and wakeup.


Friends And Related Function Documentation

friend class SoundManager [friend]
 

Definition at line 25 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 31 of file SoundManagerMsg.h.

const unsigned int SoundManagerMsg::MSG_SIZE = 16 [static]
 

maintains even word alignment

Definition at line 12 of file SoundManagerMsg.h.

RCRegion* SoundManagerMsg::region [private]
 

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

Definition at line 34 of file SoundManagerMsg.h.

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

Denotes what type of message this is.


The documentation for this struct was generated from the following file:
Tekkotsu v1.4
Generated Sat Jul 19 00:09:10 2003 by Doxygen 1.3.2