Slippers Engine
 
Loading...
Searching...
No Matches
ReverbManager Class Reference

Singleton responisble for loading and retrieving Reverbs. More...

#include <ReverbManager.h>

Collaboration diagram for ReverbManager:
Collaboration graph

Classes

struct  ReverbParams
 Struct representing Parameters for Reverbs. More...
 

Public Types

enum class  DefaultReverbs { SMALLROOM , CONCERTHALL , CAVE , STUDIO , CATHEDRAL }
 Collection of Preloaded Reverbs. More...
 

Static Public Member Functions

static void LoadReverb (const MapKey &key, const ReverbParams &param)
 Load Reverb with KEY and REVER PARAMS.
 
static const ALuint & GetReverb (DefaultReverbs key)
 Returns Reverb from DEFAULT REVERBS.
 
static ALuint GetReverb (MapKey key)
 Returns Reverb from DEFAULT REVERBS.
 

Private Types

using MapKey = std::string
 KEYS stored as STRINGS.
 

Detailed Description

Singleton responisble for loading and retrieving Reverbs.

Member Typedef Documentation

◆ MapKey

using ReverbManager::MapKey = std::string
private

KEYS stored as STRINGS.

Member Enumeration Documentation

◆ DefaultReverbs

enum class ReverbManager::DefaultReverbs
strong

Collection of Preloaded Reverbs.

Enumerator
SMALLROOM 
CONCERTHALL 
CAVE 
STUDIO 
CATHEDRAL 

Member Function Documentation

◆ GetReverb() [1/2]

static const ALuint & ReverbManager::GetReverb ( DefaultReverbs key)
static

Returns Reverb from DEFAULT REVERBS.

A function that returns a Reverb based on the enum class DefaultReverbs.

Parameters
key
Returns
const ALuint&

◆ GetReverb() [2/2]

static ALuint ReverbManager::GetReverb ( MapKey key)
static

Returns Reverb from DEFAULT REVERBS.

A function that returns a Reverb based on a user generated key. Checks if key already exists.

Parameters
key
Returns
const ALuint&

◆ LoadReverb()

static void ReverbManager::LoadReverb ( const MapKey & key,
const ReverbParams & param )
static

Load Reverb with KEY and REVER PARAMS.

A function callable in SlippersResources/LoadResources that takes in a String as a key for retrieval, as well as a Reverb Param Struct. Checks for repeated key use.

Parameters
key
param