From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_sound.html | 1748 +++++++++++++++++++++++++++++++++++++ 1 file changed, 1748 insertions(+) create mode 100644 Doc/doxygen/html/class_sound.html (limited to 'Doc/doxygen/html/class_sound.html') diff --git a/Doc/doxygen/html/class_sound.html b/Doc/doxygen/html/class_sound.html new file mode 100644 index 0000000..9559ede --- /dev/null +++ b/Doc/doxygen/html/class_sound.html @@ -0,0 +1,1748 @@ + + + + + +Starshatter_Open: Sound Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Attributes | +Static Protected Attributes
+
+
Sound Class Reference
+
+
+ +

#include <Sound.h>

+
+Inheritance diagram for Sound:
+
+
+ + +SoundD3D + +
+ +

List of all members.

+ + + + +

+Public Types

enum  FlagEnum {
+  AMBIENT = 0x0000, +LOCALIZED = 0x0001, +LOC_3D = 0x0002, +MEMORY = 0x0000, +
+  STREAMED = 0x0004, +ONCE = 0x0000, +LOOP = 0x0008, +FREE = 0x0000, +
+  LOCKED = 0x0010, +DOPPLER = 0x0020, +INTERFACE = 0x0040, +OGGVORBIS = 0x4000, +
+  RESOURCE = 0x8000 +
+ }
enum  StatusEnum {
+  UNINITIALIZED, +INITIALIZING, +READY, +PLAYING, +
+  DONE +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Sound ()
virtual ~Sound ()
int operator== (const Sound &rhs) const
virtual void Update ()
virtual void Release ()
virtual HRESULT StreamFile (const char *name, DWORD offset)
virtual HRESULT Load (DWORD bytes, BYTE *data)
virtual Sound * Duplicate ()
virtual HRESULT Play ()
virtual HRESULT Rewind ()
virtual HRESULT Pause ()
virtual HRESULT Stop ()
int IsReady () const
int IsPlaying () const
int IsDone () const
int LoopCount () const
virtual DWORD GetFlags () const
virtual void SetFlags (DWORD f)
virtual DWORD GetStatus () const
virtual long GetVolume () const
virtual void SetVolume (long v)
virtual long GetPan () const
virtual void SetPan (long p)
virtual double GetTotalTime () const
virtual double GetTimeRemaining () const
virtual double GetTimeElapsed () const
virtual const Vec3 & GetLocation () const
virtual void SetLocation (const Vec3 &l)
virtual const Vec3 & GetVelocity () const
virtual void SetVelocity (const Vec3 &v)
virtual float GetMinDistance () const
virtual void SetMinDistance (float f)
virtual float GetMaxDistance () const
virtual void SetMaxDistance (float f)
virtual void SetSoundCheck (SoundCheck *s)
virtual void AddToSoundCard ()
const char * GetFilename () const
void SetFilename (const char *s)
+ + + + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static Sound * CreateStream (const char *filename)
static Sound * CreateOggStream (const char *filename)
static Sound * Create (DWORD flags, LPWAVEFORMATEX format)
static Sound * Create (DWORD flags, LPWAVEFORMATEX format, DWORD len, LPBYTE data)
static void SetListener (const Camera &cam, const Vec3 &vel)
static void UseSoundCard (SoundCard *s)
+ + + + + + + + + +

+Protected Attributes

DWORD flags
DWORD status
long volume
int looped
Vec3 location
Vec3 velocity
SoundCheck * sound_check
char filename [64]
+ + +

+Static Protected Attributes

static SoundCard * creator = 0
+

Detailed Description

+
+

Definition at line 29 of file Sound.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum Sound::FlagEnum
+
+
Enumerator:
+ + + + + + + + + + + + + +
AMBIENT  +
LOCALIZED  +
LOC_3D  +
MEMORY  +
STREAMED  +
ONCE  +
LOOP  +
FREE  +
LOCKED  +
DOPPLER  +
INTERFACE  +
OGGVORBIS  +
RESOURCE  +
+
+
+ +

Definition at line 47 of file Sound.h.

+ +
+
+ +
+
+ + + + +
enum Sound::StatusEnum
+
+
Enumerator:
+ + + + + +
UNINITIALIZED  +
INITIALIZING  +
READY  +
PLAYING  +
DONE  +
+
+
+ +

Definition at line 62 of file Sound.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
Sound::Sound ()
+
+ +

Definition at line 237 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Sound::~Sound ()
+ 		+virtual
+
+ +

Definition at line 246 of file Sound.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void Sound::AddToSoundCard ()
+ 		+virtual
+
+ +

Definition at line 260 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Sound * Sound::Create (DWORD flags,
LPWAVEFORMATEX format 
)
+ 		+static
+
+ +

Definition at line 215 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Sound * Sound::Create (DWORD flags,
LPWAVEFORMATEX format,
DWORD len,
LPBYTE data 
)
+ 		+static
+
+ +

Definition at line 222 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Sound * Sound::CreateOggStream (const char * filename)
+ 		+static
+
+ +

Definition at line 146 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Sound * Sound::CreateStream (const char * filename)
+ 		+static
+
+ +

Definition at line 28 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Sound* Sound::Duplicate ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 82 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* Sound::GetFilename () const
+ 		+inline
+
+ +

Definition at line 125 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual DWORD Sound::GetFlags () const
+ 		+inlinevirtual
+
+ +

Definition at line 96 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual const Vec3& Sound::GetLocation () const
+ 		+inlinevirtual
+
+ +

Definition at line 112 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual float Sound::GetMaxDistance () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 119 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual float Sound::GetMinDistance () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 117 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual long Sound::GetPan () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 102 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual DWORD Sound::GetStatus () const
+ 		+inlinevirtual
+
+ +

Definition at line 98 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Sound::GetTimeElapsed () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 108 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Sound::GetTimeRemaining () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 107 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Sound::GetTotalTime () const
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 106 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual const Vec3& Sound::GetVelocity () const
+ 		+inlinevirtual
+
+ +

Definition at line 114 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual long Sound::GetVolume () const
+ 		+inlinevirtual
+
+ +

Definition at line 100 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Sound::IsDone () const
+ 		+inline
+
+ +

Definition at line 93 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Sound::IsPlaying () const
+ 		+inline
+
+ +

Definition at line 92 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Sound::IsReady () const
+ 		+inline
+
+ +

Definition at line 91 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual HRESULT Sound::Load (DWORD bytes,
BYTE * data 
)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 79 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Sound::LoopCount () const
+ 		+inline
+
+ +

Definition at line 94 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Sound::operator== (const Sound & rhs) const
+ 		+inline
+
+ +

Definition at line 45 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual HRESULT Sound::Pause ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 87 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual HRESULT Sound::Play ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 85 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Sound::Release ()
+ 		+virtual
+
+ +

Definition at line 252 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual HRESULT Sound::Rewind ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 86 of file Sound.h.

+ +
+
+ +
+
+ + + + + + + + +
void Sound::SetFilename (const char * s)
+
+ +

Definition at line 269 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetFlags (DWORD f)
+ 		+inlinevirtual
+
+ +

Definition at line 97 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Sound::SetListener (const Camera & cam,
const Vec3 & vel 
)
+ 		+static
+
+ +

Definition at line 229 of file Sound.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetLocation (const Vec3 & l)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 113 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetMaxDistance (float f)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 120 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetMinDistance (float f)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 118 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetPan (long p)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 103 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetSoundCheck (SoundCheck * s)
+ 		+inlinevirtual
+
+ +

Definition at line 122 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetVelocity (const Vec3 & v)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 115 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Sound::SetVolume (long v)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 101 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual HRESULT Sound::Stop ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 88 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual HRESULT Sound::StreamFile (const char * name,
DWORD offset 
)
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 76 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* Sound::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 32 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void Sound::Update ()
+ 		+inlinevirtual
+
+ +

Reimplemented in SoundD3D.

+ +

Definition at line 69 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
static void Sound::UseSoundCard (SoundCard * s)
+ 		+inlinestatic
+
+ +

Definition at line 39 of file Sound.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
SoundCard * Sound::creator = 0
+ 		+staticprotected
+
+ +

Definition at line 138 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
char Sound::filename[64]
+ 		+protected
+
+ +

Definition at line 136 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD Sound::flags
+ 		+protected
+
+ +

Definition at line 129 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 Sound::location
+ 		+protected
+
+ +

Definition at line 133 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Sound::looped
+ 		+protected
+
+ +

Definition at line 132 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
SoundCheck* Sound::sound_check
+ 		+protected
+
+ +

Definition at line 135 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD Sound::status
+ 		+protected
+
+ +

Definition at line 130 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 Sound::velocity
+ 		+protected
+
+ +

Definition at line 134 of file Sound.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
long Sound::volume
+ 		+protected
+
+ +

Definition at line 131 of file Sound.h.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • D:/SRC/StarshatterSVN/nGenEx/Sound.h
    • +
  • D:/SRC/StarshatterSVN/nGenEx/Sound.cpp
    • +
+
+
+ + + + -- cgit v1.1