Tekkotsu 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
 add
 indicates a new sound to be played
 del
 indicates the sound with id should be stopped
 wakeup
 indicates that it's time to start sending sounds to the system
 unknown
 initial value for type until one of the others is assigned
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 indicates how this message should be processed.
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 Enumeration Documentation

enum SoundManagerMsg::MsgType [private]

Denotes what type of message this is.

Enumerator:
add  indicates a new sound to be played
del  indicates the sound with id should be stopped
wakeup  indicates that it's time to start sending sounds to the system
unknown  initial value for type until one of the others is assigned

Definition at line 16 of file SoundManagerMsg.h.


Constructor & Destructor Documentation

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 37 of file SoundManagerMsg.h.


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

Tekkotsu v3.0
Generated Fri May 11 20:08:49 2007 by Doxygen 1.4.7