Changeset 4206 in orxonox.OLD for orxonox/branches/openAL/src/lib/sound/sound_engine.h

Timestamp:

May 17, 2005, 2:30:10 AM (20 years ago)

Author:

bensch

Message:

orxonox/branches/openAL: doxygen-Tags

File:

• orxonox/branches/openAL/src/lib/sound/sound_engine.h (modified) (4 diffs)

orxonox/branches/openAL/src/lib/sound/sound_engine.h

@@ -12 +12 @@
 
 
-#define SOUND_DOPPLER_FACTOR     0.01
-#define SOUND_DOPPLER_VELOCITY   500000000
+#define SOUND_DOPPLER_FACTOR     0.01          //!< A factor for the audible doppler effect
+#define SOUND_DOPPLER_VELOCITY   500000000     //!< A factor for the TravelSpeed of sound
 
 // FORWARD DEFINITION
@@ -27 +27 @@
   ~SoundBuffer(void);
 
+  /** \returns the ID of the buffer */
   inline ALuint getID(void) { return this->bufferID; }
 
@@ -47 +48 @@
   void stop();
   void pause();
+  void rewind();
 
   // development functions
-  /** \retruns The ID of the Source */
+  /** \returns The ID of the Source */
   inline ALuint getID(void) { return this->sourceID; }
   /** \returns the SourceNode of this Source */
@@ -86 +88 @@
   // error handling:
   static void PrintALErrorString(ALenum err);
-  static void PrintALCErrorString(ALenum err);
+  //  static void PrintALCErrorString(ALenum err);
 
  private: