API Documentation
ComplexEffectManager.h
1 // ComplexEffectManager.h
3 //
5 
6 namespace nkAstraeus
7 {
13  class ComplexEffectManager final : public nkCommon::MaybeSingletonClass<ComplexEffectManager>
14  {
15  public :
16 
17  // Management
69  ComplexEffect* getByIndex (unsigned int id) ;
76  void rename (nkMemory::StringView currentName, nkMemory::StringView newName) ;
90  } ;
91 }
nkAstraeus::ComplexEffectManager::relinquish
nkMemory::UniquePtr< ComplexEffect > relinquish(nkMemory::StringView name)
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition: ComplexEffectType.h:12
nkAstraeus::ComplexEffectManager::get
ComplexEffect * get(nkMemory::StringView name)
nkAstraeus::ComplexEffectManager::erase
void erase(nkMemory::StringView name)
nkAstraeus::ComplexEffectManager::createOrRetrieve
ComplexEffect * createOrRetrieve(nkMemory::StringView name, COMPLEX_EFFECT_TYPE type)
nkAstraeus::ComplexEffectManager::rename
void rename(nkMemory::StringView currentName, nkMemory::StringView newName)
nkAstraeus::ComplexEffectManager::record
ComplexEffect * record(nkMemory::StringView name, nkMemory::UniquePtr< ComplexEffect > resource)
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkAstraeus::ComplexEffectManager
Manages the complex effects available in the component.
Definition: ComplexEffectManager.h:14
nkAstraeus::ComplexEffectManager::getByIndex
ComplexEffect * getByIndex(unsigned int id)