#include <audiofeatureunit.h>
Detailed Description
Sets up and interfaces with the audio subsystem.
- Copyright
- (C) 2022 Individual contributors, see AUTHORS file
Inherits Game::FeatureUnit.
Private Member Functions | |
| __DeclareClass(AudioFeatureUnit) __DeclareSingleton(AudioFeatureUnit) public | ~AudioFeatureUnit () |
| destructor | |
| void | OnAttach () |
| called from GameServer::AttachGameFeature() | |
| void | OnActivate () |
| called after GameServer::AttachGameFeature() | |
| void | OnDeactivate () |
| called before GameServer::RemoveGameFeature() | |
| virtual void | OnBeginFrame () |
| called on begin of frame | |
| virtual void | OnRenderDebug () |
| called when game debug visualization is on | |
Private Attributes | |
| Ptr< Audio::AudioServer > | audioServer |
Additional Inherited Members | |
 Public Member Functions inherited from Core::RefCounted | |
| RefCounted () | |
| constructor | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
| Static Public Member Functions inherited from Core::RefCounted | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!) | |
| Protected Member Functions inherited from Core::RefCounted | |
| virtual | ~RefCounted () |
| destructor (called when refcount reaches zero) | |
| Protected Attributes inherited from Game::FeatureUnit | |
| Util::Array< Ptr< Manager > > | managers |
| bool | active |
| Util::CommandLineArgs | args |
| cmdline args for configuration from cmdline | |
Constructor & Destructor Documentation
◆ ~AudioFeatureUnit()
|
private |
destructor
Member Function Documentation
◆ OnActivate()
|
privatevirtual |
called after GameServer::AttachGameFeature()
This method is called by Game::GameServer::AttachGameFeature().
Use this method for one-time initializations of the FeatureUnit.
Reimplemented from Game::FeatureUnit.
◆ OnAttach()
|
privatevirtual |
called from GameServer::AttachGameFeature()
Reimplemented from Game::FeatureUnit.
◆ OnBeginFrame()
|
privatevirtual |
called on begin of frame
This method is called from Game::GameServer::OnBeginFrame() on all game features attached to an GameServer in the order of attachment.
Override this method if your FeatureUnit has to do any work at the beginning of the frame.
Reimplemented from Game::FeatureUnit.
◆ OnDeactivate()
|
privatevirtual |
called before GameServer::RemoveGameFeature()
This method is called by Game::GameServer::RemoveGameFeature().
Use this method to cleanup stuff which has been initialized in OnActivate().
Reimplemented from Game::FeatureUnit.
◆ OnRenderDebug()
|
privatevirtual |
called when game debug visualization is on
This method is called from Game::GameServer::OnRenderDebug() on all game features attached to an GameServer in the order of attachment.
It's meant for debug issues. It will be called when debug mode is enabled.
Reimplemented from Game::FeatureUnit.
Member Data Documentation
◆ audioServer
|
private |
The documentation for this class was generated from the following files:
- /github/workspace/code/addons/audiofeature/audiofeatureunit.h
- /github/workspace/code/addons/audiofeature/audiofeatureunit.cc