API Documentation
MAIN PAGE
NAMESPACES
CLASSES
Documentation
Headers
NilkinsAstraeus
Graphics
ComplexEffects
Blur
BlurComplexEffect.h
1
// BlurComplexEffect.h
3
//
5
6
namespace
nkAstraeus
7
{
13
class
BlurComplexEffect
final :
public
ComplexEffect
14
{
15
public :
16
23
BlurComplexEffect
(
System
* system) noexcept ;
27
virtual
~BlurComplexEffect
() ;
28
29
// Getters
33
nkGraphics::Texture
*
getSourceTexture
()
const
;
40
nkGraphics::Texture
*
getOutputTexture
()
const
;
44
unsigned
int
getKernelRadius
()
const
;
48
bool
getAlphaEncodesBlurPlanes
()
const
;
52
bool
getPreserveAlpha
()
const
;
53
54
// Setters
62
void
setSourceTexture
(
nkGraphics::Texture
* value) ;
71
void
setKernelRadius
(
unsigned
int
value) ;
82
void
setAlphaEncodesBlurPlanes
(
bool
value) ;
93
void
setPreserveAlpha
(
bool
value) ;
94
95
// Load
96
virtual
bool
load
()
override
;
97
virtual
void
unload
()
override
;
98
99
public :
100
101
// Statics
112
static
nkMemory::UniquePtr<BlurComplexEffect>
create
(
System
* system =
nullptr
) ;
113
} ;
114
}
nkAstraeus::BlurComplexEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::BlurComplexEffect
A blurring effect.
Definition:
BlurComplexEffect.h:14
nkAstraeus::BlurComplexEffect::getPreserveAlpha
bool getPreserveAlpha() const
nkAstraeus::BlurComplexEffect::~BlurComplexEffect
virtual ~BlurComplexEffect()
nkAstraeus::BlurComplexEffect::setKernelRadius
void setKernelRadius(unsigned int value)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition:
Texture.h:35
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition:
System.h:15
nkAstraeus::BlurComplexEffect::setPreserveAlpha
void setPreserveAlpha(bool value)
nkAstraeus::BlurComplexEffect::BlurComplexEffect
BlurComplexEffect(System *system) noexcept
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
nkAstraeus::BlurComplexEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::BlurComplexEffect::load
virtual bool load() override
nkAstraeus::BlurComplexEffect::unload
virtual void unload() override
nkAstraeus::BlurComplexEffect::getAlphaEncodesBlurPlanes
bool getAlphaEncodesBlurPlanes() const
nkAstraeus::BlurComplexEffect::getKernelRadius
unsigned int getKernelRadius() const
nkAstraeus::BlurComplexEffect::create
static nkMemory::UniquePtr< BlurComplexEffect > create(System *system=nullptr)
nkAstraeus::BlurComplexEffect::setAlphaEncodesBlurPlanes
void setAlphaEncodesBlurPlanes(bool value)
nkAstraeus::BlurComplexEffect::getOutputTexture
nkGraphics::Texture * getOutputTexture() const
Generated by
Doxygen
1.8.18