Drag[en]gine Game Engine  1.0
deSynthesizer Class Reference

Synthesizer producing dynamic sounds from sources. More...

#include <deSynthesizer.h>

Inheritance diagram for deSynthesizer:
deResource deObject

Public Member Functions

Management
int GetChannelCount () const
 Number of channels. More...
 
void SetChannelCount (int channelCount)
 Set number of channels. More...
 
int GetSampleRate () const
 Sample rate. More...
 
void SetSampleRate (int sampleRate)
 Set sample rate. More...
 
int GetBytesPerSample () const
 Bytes per sample. More...
 
void SetBytesPerSample (int bytesPerSample)
 Set bytes per sample. More...
 
int GetSampleCount () const
 Number of samples to create. More...
 
void SetSampleCount (int sampleCount)
 Set number of samples to create. More...
 
Controllers
int GetControllerCount () const
 Number of controllers. More...
 
deSynthesizerControllerGetControllerAt (int index) const
 Controller at index. More...
 
int IndexOfController (deSynthesizerController *controller) const
 Index of controller or -1 if absent. More...
 
bool HasController (deSynthesizerController *controller) const
 Controller is present. More...
 
void AddController (deSynthesizerController *controller)
 Add controller. More...
 
void RemoveController (deSynthesizerController *controller)
 Remove controller. More...
 
void RemoveAllControllers ()
 Remove all controllers. More...
 
void NotifyControllersChanged ()
 Notify peers controllers changed. More...
 
Links
int GetLinkCount () const
 Number of links. More...
 
deSynthesizerLinkGetLinkAt (int index) const
 Link at index. More...
 
int IndexOfLink (deSynthesizerLink *link) const
 Index of link or -1 if absent. More...
 
bool HasLink (deSynthesizerLink *link) const
 Link is present. More...
 
void AddLink (deSynthesizerLink *link)
 Add link. More...
 
void RemoveLink (deSynthesizerLink *link)
 Remove link. More...
 
void RemoveAllLinks ()
 Remove all links. More...
 
void NotifyLinksChanged ()
 Notify peers links changed. More...
 
Sources
int GetSourceCount () const
 Number of sources. More...
 
deSynthesizerSourceGetSourceAt (int index) const
 Source at index. More...
 
int IndexOfSource (deSynthesizerSource *source) const
 Index of source or -1 if absent. More...
 
bool HasSource (deSynthesizerSource *source) const
 Source is present. More...
 
void AddSource (deSynthesizerSource *source)
 Add source. More...
 
void RemoveSource (deSynthesizerSource *source)
 Remove source. More...
 
void RemoveAllSources ()
 Remove all sources. More...
 
void NotifySourcesChanged ()
 Notify peers sources changed. More...
 
System Peers
deBaseSynthesizerSynthesizerGetPeerSynthesizer () const
 Synthesizer system peer or NULL if not set. More...
 
void SetPeerSynthesizer (deBaseSynthesizerSynthesizer *peer)
 Set synthesizer system peer. More...
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deSynthesizer (deSynthesizerManager *manager)
 Create synthesizer. More...
 
virtual ~deSynthesizer ()
 Clean up synthesizer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Synthesizer producing dynamic sounds from sources.

Contains the definition for producing sounds. Use deSynthesizerInstance for to actually produce sounds using individual parameters. Multiple synthesizer instances can share the same synthesizer.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deSynthesizer()

deSynthesizer::deSynthesizer ( deSynthesizerManager manager)

Create synthesizer.

◆ ~deSynthesizer()

virtual deSynthesizer::~deSynthesizer ( )
protectedvirtual

Clean up synthesizer.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ AddController()

void deSynthesizer::AddController ( deSynthesizerController controller)

Add controller.

Referenced by GetSampleCount().

◆ AddLink()

void deSynthesizer::AddLink ( deSynthesizerLink link)

Add link.

Referenced by GetSampleCount().

◆ AddSource()

void deSynthesizer::AddSource ( deSynthesizerSource source)

Add source.

Referenced by GetSampleCount().

◆ GetBytesPerSample()

int deSynthesizer::GetBytesPerSample ( ) const
inline

Bytes per sample.

References SetBytesPerSample().

◆ GetChannelCount()

int deSynthesizer::GetChannelCount ( ) const
inline

Number of channels.

References SetChannelCount().

◆ GetControllerAt()

deSynthesizerController* deSynthesizer::GetControllerAt ( int  index) const

Controller at index.

Exceptions
deeOutOfBoundaryindex is less than 0 or larger than or equal to GetControllerCount().

Referenced by GetSampleCount().

◆ GetControllerCount()

int deSynthesizer::GetControllerCount ( ) const

Number of controllers.

Referenced by GetSampleCount().

◆ GetLinkAt()

deSynthesizerLink* deSynthesizer::GetLinkAt ( int  index) const

Link at index.

Exceptions
deeOutOfBoundaryindex is less than 0 or larger than or equal to GetLinkCount().

Referenced by GetSampleCount().

◆ GetLinkCount()

int deSynthesizer::GetLinkCount ( ) const

Number of links.

Referenced by GetSampleCount().

◆ GetPeerSynthesizer()

deBaseSynthesizerSynthesizer* deSynthesizer::GetPeerSynthesizer ( ) const
inline

Synthesizer system peer or NULL if not set.

References SetPeerSynthesizer().

◆ GetSampleCount()

◆ GetSampleRate()

int deSynthesizer::GetSampleRate ( ) const
inline

Sample rate.

References SetSampleRate().

◆ GetSourceAt()

deSynthesizerSource* deSynthesizer::GetSourceAt ( int  index) const

Source at index.

Exceptions
deeOutOfBoundaryindex is less than 0 or larger than or equal to GetSourceCount().

Referenced by GetSampleCount().

◆ GetSourceCount()

int deSynthesizer::GetSourceCount ( ) const

Number of sources.

Referenced by GetSampleCount().

◆ HasController()

bool deSynthesizer::HasController ( deSynthesizerController controller) const

Controller is present.

Referenced by GetSampleCount().

◆ HasLink()

bool deSynthesizer::HasLink ( deSynthesizerLink link) const

Link is present.

Referenced by GetSampleCount().

◆ HasSource()

bool deSynthesizer::HasSource ( deSynthesizerSource source) const

Source is present.

Referenced by GetSampleCount().

◆ IndexOfController()

int deSynthesizer::IndexOfController ( deSynthesizerController controller) const

Index of controller or -1 if absent.

Referenced by GetSampleCount().

◆ IndexOfLink()

int deSynthesizer::IndexOfLink ( deSynthesizerLink link) const

Index of link or -1 if absent.

Referenced by GetSampleCount().

◆ IndexOfSource()

int deSynthesizer::IndexOfSource ( deSynthesizerSource source) const

Index of source or -1 if absent.

Referenced by GetSampleCount().

◆ NotifyControllersChanged()

void deSynthesizer::NotifyControllersChanged ( )

Notify peers controllers changed.

Referenced by GetSampleCount().

◆ NotifyLinksChanged()

void deSynthesizer::NotifyLinksChanged ( )

Notify peers links changed.

Referenced by GetSampleCount().

◆ NotifySourcesChanged()

void deSynthesizer::NotifySourcesChanged ( )

Notify peers sources changed.

Referenced by GetSampleCount().

◆ RemoveAllControllers()

void deSynthesizer::RemoveAllControllers ( )

Remove all controllers.

Referenced by GetSampleCount().

◆ RemoveAllLinks()

void deSynthesizer::RemoveAllLinks ( )

Remove all links.

Referenced by GetSampleCount().

◆ RemoveAllSources()

void deSynthesizer::RemoveAllSources ( )

Remove all sources.

Referenced by GetSampleCount().

◆ RemoveController()

void deSynthesizer::RemoveController ( deSynthesizerController controller)

Remove controller.

Exceptions
deeInvalidParamcontroller is absent.

Referenced by GetSampleCount().

◆ RemoveLink()

void deSynthesizer::RemoveLink ( deSynthesizerLink link)

Remove link.

Exceptions
deeInvalidParamlink is absent.

Referenced by GetSampleCount().

◆ RemoveSource()

void deSynthesizer::RemoveSource ( deSynthesizerSource source)

Remove source.

Exceptions
deeOutOfBoundarysource is absent.

Referenced by GetSampleCount().

◆ SetBytesPerSample()

void deSynthesizer::SetBytesPerSample ( int  bytesPerSample)

Set bytes per sample.

Referenced by GetBytesPerSample().

◆ SetChannelCount()

void deSynthesizer::SetChannelCount ( int  channelCount)

Set number of channels.

Referenced by GetChannelCount().

◆ SetPeerSynthesizer()

void deSynthesizer::SetPeerSynthesizer ( deBaseSynthesizerSynthesizer peer)

Set synthesizer system peer.

Referenced by GetPeerSynthesizer().

◆ SetSampleCount()

void deSynthesizer::SetSampleCount ( int  sampleCount)

Set number of samples to create.

Referenced by GetSampleCount().

◆ SetSampleRate()

void deSynthesizer::SetSampleRate ( int  sampleRate)

Set sample rate.

Referenced by GetSampleRate().


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