SuperTuxKart
Loading...
Searching...
No Matches
Public Member Functions | List of all members
DummySFX Class Reference

Dummy sound when ogg or openal aren't available. More...

#include <dummy_sfx.hpp>

Inheritance diagram for DummySFX:
Inheritance graph
[legend]

Public Member Functions

 DummySFX (SFXBuffer *buffer, bool positional, float gain)
 
virtual bool init () OVERRIDE
 Late creation, if SFX was initially disabled.
 
virtual bool isLooped () OVERRIDE
 
virtual void updatePlayingSFX (float dt) OVERRIDE
 
virtual void setLoop (bool status) OVERRIDE
 
virtual void reallySetLoop (bool status) OVERRIDE
 
virtual void setPosition (const Vec3 &p) OVERRIDE
 
virtual void reallySetPosition (const Vec3 &p) OVERRIDE
 
virtual void setSpeedPosition (float factor, const Vec3 &p) OVERRIDE
 
virtual void reallySetSpeedPosition (float f, const Vec3 &p) OVERRIDE
 
virtual void play () OVERRIDE
 
virtual void reallyPlayNow (SFXBuffer *buffer=NULL) OVERRIDE
 
virtual void play (const Vec3 &xyz, SFXBuffer *buffer=NULL) OVERRIDE
 
virtual void reallyPlayNow (const Vec3 &xyz, SFXBuffer *buffer=NULL) OVERRIDE
 
virtual void stop () OVERRIDE
 
virtual void reallyStopNow () OVERRIDE
 
virtual void pause () OVERRIDE
 
virtual void reallyPauseNow () OVERRIDE
 
virtual void resume () OVERRIDE
 
virtual void reallyResumeNow () OVERRIDE
 
virtual void deleteSFX () OVERRIDE
 
virtual void setSpeed (float factor) OVERRIDE
 
virtual void reallySetSpeed (float factor) OVERRIDE
 
virtual void setVolume (float gain) OVERRIDE
 
virtual void reallySetVolume (float gain) OVERRIDE
 
virtual void setMasterVolume (float gain) OVERRIDE
 
virtual void reallySetMasterVolumeNow (float gain) OVERRIDE
 
virtual SFXStatus getStatus () OVERRIDE
 
virtual void onSoundEnabledBack () OVERRIDE
 
virtual void setRolloff (float rolloff) OVERRIDE
 
virtual SFXBuffergetBuffer () const OVERRIDE
 
virtual bool init ()=0
 Late creation, if SFX was initially disabled.
 
virtual bool isLooped ()=0
 
virtual void updatePlayingSFX (float dt)=0
 
virtual void setPosition (const Vec3 &p)=0
 
virtual void reallySetPosition (const Vec3 &p)=0
 
virtual void setSpeedPosition (float factor, const Vec3 &p)=0
 
virtual void reallySetSpeedPosition (float f, const Vec3 &p)=0
 
virtual void setLoop (bool status)=0
 
virtual void reallySetLoop (bool status)=0
 
virtual void play ()=0
 
virtual void reallyPlayNow (SFXBuffer *buffer=NULL)=0
 
virtual void play (const Vec3 &xyz, SFXBuffer *buffer=NULL)=0
 
virtual void reallyPlayNow (const Vec3 &xyz, SFXBuffer *buffer=NULL)=0
 
virtual void stop ()=0
 
virtual void reallyStopNow ()=0
 
virtual void pause ()=0
 
virtual void reallyPauseNow ()=0
 
virtual void resume ()=0
 
virtual void reallyResumeNow ()=0
 
virtual void deleteSFX ()=0
 
virtual void setSpeed (float factor)=0
 
virtual void reallySetSpeed (float factor)=0
 
virtual void setVolume (float gain)=0
 
virtual void reallySetVolume (float gain)=0
 
virtual void setMasterVolume (float gain)=0
 
virtual void reallySetMasterVolumeNow (float gain)=0
 
virtual void onSoundEnabledBack ()=0
 
virtual void setRolloff (float rolloff)=0
 
virtual SFXBuffergetBuffer () const =0
 
virtual SFXStatus getStatus ()=0
 

Additional Inherited Members

- Public Types inherited from SFXBase
enum  SFXStatus : int {
  SFX_UNKNOWN = -1 , SFX_STOPPED = 0 , SFX_PAUSED = 1 , SFX_PLAYING = 2 ,
  SFX_NOT_INITIALISED = 3
}
 Status of a sound effect.
 

Detailed Description

Dummy sound when ogg or openal aren't available.

Member Function Documentation

◆ deleteSFX()

virtual void DummySFX::deleteSFX ( )
inlinevirtual

Implements SFXBase.

◆ getBuffer()

virtual SFXBuffer * DummySFX::getBuffer ( ) const
inlinevirtual

Implements SFXBase.

◆ getStatus()

virtual SFXStatus DummySFX::getStatus ( )
inlinevirtual

Implements SFXBase.

◆ init()

virtual bool DummySFX::init ( )
inlinevirtual

Late creation, if SFX was initially disabled.

Implements SFXBase.

◆ isLooped()

virtual bool DummySFX::isLooped ( )
inlinevirtual

Implements SFXBase.

◆ onSoundEnabledBack()

virtual void DummySFX::onSoundEnabledBack ( )
inlinevirtual

Implements SFXBase.

◆ pause()

virtual void DummySFX::pause ( )
inlinevirtual

Implements SFXBase.

◆ play() [1/2]

virtual void DummySFX::play ( )
inlinevirtual

Implements SFXBase.

◆ play() [2/2]

virtual void DummySFX::play ( const Vec3 xyz,
SFXBuffer buffer = NULL 
)
inlinevirtual

Implements SFXBase.

◆ reallyPauseNow()

virtual void DummySFX::reallyPauseNow ( )
inlinevirtual

Implements SFXBase.

◆ reallyPlayNow() [1/2]

virtual void DummySFX::reallyPlayNow ( const Vec3 xyz,
SFXBuffer buffer = NULL 
)
inlinevirtual

Implements SFXBase.

◆ reallyPlayNow() [2/2]

virtual void DummySFX::reallyPlayNow ( SFXBuffer buffer = NULL)
inlinevirtual

Implements SFXBase.

◆ reallyResumeNow()

virtual void DummySFX::reallyResumeNow ( )
inlinevirtual

Implements SFXBase.

◆ reallySetLoop()

virtual void DummySFX::reallySetLoop ( bool  status)
inlinevirtual

Implements SFXBase.

◆ reallySetMasterVolumeNow()

virtual void DummySFX::reallySetMasterVolumeNow ( float  gain)
inlinevirtual

Implements SFXBase.

◆ reallySetPosition()

virtual void DummySFX::reallySetPosition ( const Vec3 p)
inlinevirtual

Implements SFXBase.

◆ reallySetSpeed()

virtual void DummySFX::reallySetSpeed ( float  factor)
inlinevirtual

Implements SFXBase.

◆ reallySetSpeedPosition()

virtual void DummySFX::reallySetSpeedPosition ( float  f,
const Vec3 p 
)
inlinevirtual

Implements SFXBase.

◆ reallySetVolume()

virtual void DummySFX::reallySetVolume ( float  gain)
inlinevirtual

Implements SFXBase.

◆ reallyStopNow()

virtual void DummySFX::reallyStopNow ( )
inlinevirtual

Implements SFXBase.

◆ resume()

virtual void DummySFX::resume ( )
inlinevirtual

Implements SFXBase.

◆ setLoop()

virtual void DummySFX::setLoop ( bool  status)
inlinevirtual

Implements SFXBase.

◆ setMasterVolume()

virtual void DummySFX::setMasterVolume ( float  gain)
inlinevirtual

Implements SFXBase.

◆ setPosition()

virtual void DummySFX::setPosition ( const Vec3 p)
inlinevirtual

Implements SFXBase.

◆ setRolloff()

virtual void DummySFX::setRolloff ( float  rolloff)
inlinevirtual

Implements SFXBase.

◆ setSpeed()

virtual void DummySFX::setSpeed ( float  factor)
inlinevirtual

Implements SFXBase.

◆ setSpeedPosition()

virtual void DummySFX::setSpeedPosition ( float  factor,
const Vec3 p 
)
inlinevirtual

Implements SFXBase.

◆ setVolume()

virtual void DummySFX::setVolume ( float  gain)
inlinevirtual

Implements SFXBase.

◆ stop()

virtual void DummySFX::stop ( )
inlinevirtual

Implements SFXBase.

◆ updatePlayingSFX()

virtual void DummySFX::updatePlayingSFX ( float  dt)
inlinevirtual

Implements SFXBase.


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