Wasabi
Public Member Functions | Public Attributes | Protected Attributes | Friends | List of all members
WSoundComponent Class Referenceabstract
Inheritance diagram for WSoundComponent:
WOpenALSoundComponent

Public Member Functions

 WSoundComponent (class Wasabi *const app)
 
virtual WError Initialize ()=0
 
virtual void Cleanup ()=0
 
virtual WSoundCreateSound (uint32_t ID=0) const =0
 
virtual void SetSoundSpeed (float fSpeed)
 
virtual void SetDopplerFactor (float fFactor)
 
virtual void SetMasterGain (float fGain)
 
virtual void SetListenerPosition (float x, float y, float z)
 
virtual void SetListenerPosition (WVector3 pos)
 
virtual void SetListenerPosition (class WOrientation *pos)
 
virtual void SetListenerVelocity (float x, float y, float z)
 
virtual void SetListenerVelocity (WVector3 vel)
 
virtual void SetListenerOrientation (WVector3 look, WVector3 up)
 
virtual void SetListenerOrientation (class WOrientation *ori)
 
virtual void SetListenerToOrientation (class WOrientation *ori)
 

Public Attributes

class WSoundManagerSoundManager
 

Protected Attributes

class Wasabim_app
 

Friends

class WSound
 

Member Function Documentation

◆ Cleanup()

virtual void WSoundComponent::Cleanup ( )
pure virtual

Frees all resources allocated by the sounds component.

Implemented in WOpenALSoundComponent.

◆ CreateSound()

virtual WSound* WSoundComponent::CreateSound ( uint32_t  ID = 0) const
pure virtual

Creates a new sound instance. This is equivalent to calling new WSound(app, ID), so care must be taken to free the resource when done with it.

Parameters
IDID for the created sound
Returns
A newly allocated sound instance

Implemented in WOpenALSoundComponent.

◆ Initialize()

virtual WError WSoundComponent::Initialize ( )
pure virtual

Initializes the sound component.

Returns
Error code, see WError.h

Implemented in WOpenALSoundComponent.

Member Data Documentation

◆ m_app

class Wasabi* WSoundComponent::m_app
protected

A pointer to the Wasabi application


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