API Documentation
FxaaEffect.h
1 // FxaaEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
17  class FxaaEffect final : public Effect
18  {
19  public :
20 
27  FxaaEffect (System* system) noexcept ;
31  virtual ~FxaaEffect () ;
32 
33  // Getters
41  float getMinContrast () const ;
45  float getMinLuminance () const ;
49  float getSmoothingStrength () const ;
58 
59  // Setters
81  void setMinContrast (float value) ;
94  void setMinLuminance (float value) ;
105  void setSmoothingStrength (float value) ;
114  void setPreset (FXAA_PRESET value) ;
123  void setLuminanceAsGreenChannelOnly (bool value) ;
124 
125  // Load
126  virtual bool load () override ;
127  virtual void unload () override ;
128 
129  public :
130 
131  // Statics
142  static nkMemory::UniquePtr<FxaaEffect> create (System* system = nullptr) ;
143  } ;
144 }
nkAstraeus::FxaaEffect::create
static nkMemory::UniquePtr< FxaaEffect > create(System *system=nullptr)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::FxaaEffect::getMinLuminance
float getMinLuminance() const
nkAstraeus::FxaaEffect::FxaaEffect
FxaaEffect(System *system) noexcept
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus::FxaaEffect::load
virtual bool load() override
nkAstraeus::FxaaEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::FxaaEffect::unload
virtual void unload() override
nkAstraeus::FxaaEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::FxaaEffect::setSmoothingStrength
void setSmoothingStrength(float value)
nkAstraeus::FxaaEffect::getPreset
FXAA_PRESET getPreset() const
nkAstraeus::FxaaEffect::setLuminanceAsGreenChannelOnly
void setLuminanceAsGreenChannelOnly(bool value)
nkAstraeus::FxaaEffect
A Fast Approximate Anti-Aliasing effect.
Definition: FxaaEffect.h:18
nkAstraeus::FxaaEffect::getMinContrast
float getMinContrast() const
nkAstraeus::FxaaEffect::setPreset
void setPreset(FXAA_PRESET value)
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
nkAstraeus::FxaaEffect::getLuminanceAsGreenChannelOnly
bool getLuminanceAsGreenChannelOnly() const
nkAstraeus::FxaaEffect::setMinContrast
void setMinContrast(float value)
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkAstraeus::FxaaEffect::~FxaaEffect
virtual ~FxaaEffect()
nkAstraeus::FXAA_PRESET
FXAA_PRESET
Describes all FXAA effect presets available.
Definition: FxaaPreset.h:19
nkAstraeus::FxaaEffect::getSmoothingStrength
float getSmoothingStrength() const
nkAstraeus::FxaaEffect::setMinLuminance
void setMinLuminance(float value)