Kanzi  3.9.4
Kanzi Engine API
kanzi::BlurEffectRenderer2D Class Reference

Blur effect renderer class. More...

#include <kanzi/core.ui/effect/blur_effect_renderer2d.hpp>

Inheritance diagram for kanzi::BlurEffectRenderer2D:
[legend]

Public Member Functions

void setMaskedBlurEnabled (bool enabled)
 Sets the masked blur mode. More...
 
void setQuality (BlurEffect2D::Quality quality)
 Sets the quality of the blur. More...
 
void setRadius (float radius)
 Sets the pixel radius of the blur. More...
 
- Public Member Functions inherited from kanzi::NodeEffectRenderer2D
void beginEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const Matrix3x3 &worldTransform, Vector2 requiredSize, bool alphaRequired, bool depthRequired, bool stencilRequired)
 Begins the effect. More...
 
void blitEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, QuadDescription &effectQuad, const Matrix3x3 &transform, const Matrix4x4 *perspectiveMatrix, const Matrix4x4 *projectionMatrix, int blendMode, bool needsClear)
 Blits the effect to the current framebuffer. More...
 
void endEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager)
 Ends the effect. More...
 
NodeEffect2DSharedPtr getEffect () const
 Get NodeEffect2D instance where this renderer has been instantiated from. More...
 
void restoreResources ()
 Restores resources after the rendering context has been lost. More...
 
virtual ~NodeEffectRenderer2D ()
 Declare NodeEffectRenderer2D as not movable nor copyable. More...
 

Static Public Member Functions

static BlurEffectRenderer2DUniquePtr create (BlurEffect2DSharedPtr blurEffect)
 Creates instances of BlurEffectRenderer2D. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::NodeEffectRenderer2D
using EffectPassContainer = vector< EffectPass >
 Container for effect passes. More...
 
- Protected Member Functions inherited from kanzi::NodeEffectRenderer2D
EffectPassaddEffectPass ()
 Adds an effect pass and gets a reference to that pass. More...
 
void beginInitialEffectPass (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, bool alphaRequired, bool depthRequired, bool stencilRequired)
 Begins the initial effect pass (effect pass at index 0). More...
 
void blitFinalEffectPass (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, QuadDescription &effectQuad, const Matrix3x3 &transform, const Matrix4x4 *perspectiveMatrix, const Matrix4x4 *projectionMatrix, int blendMode, bool needsClear)
 Blits the final effect pass, whose index is getEffectPassCount() - 1, and handles the perspective transform if necessary. More...
 
void blitIntermediateEffectPass (int effectPassIndex, Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager)
 Blits the intermediate effect pass. More...
 
void clearRenderTarget (Renderer3D &renderer, CompositionStack &compositionStack, TextureSharedPtr texture, ColorRGBA clearColor)
 Clears the render target texture with a given color. More...
 
void clearRenderTarget (Renderer3D &renderer, CompositionStack &compositionStack, NativeFramebufferHandle framebufferHandle, ColorRGBA clearColor)
 Clears the native framebuffer with a given color. More...
 
void endInitialEffectPass (CompositionStack &compositionStack)
 Ends the initial effect pass, whose index is 0. More...
 
void finalizeEffectPasses ()
 Finalizes the effect passes. More...
 
Vector2 getEffectInputTexelSize (int effectPassIndex, int inputIndex)
 Gets the texel size of the input effect pass texture in texture coordinates. More...
 
EffectPassgetEffectPass (int index)
 Gets a reference to the effect pass at a given index. More...
 
size_t getEffectPassCount () const
 Gets the number of effect passes. More...
 
int getLastEffectPassIndex () const
 Gets the index of the last effect pass. More...
 
 NodeEffectRenderer2D (NodeEffect2DSharedPtr nodeEffect)
 Constructor. More...
 
void releaseEffectPassInputRenderTargets (NodeEffectRenderer2D::EffectPass &currentEffectPass, CompositionManager *compositionManager)
 Releases those temporary render targets used by input that have EffectPass::Input::releaseRenderTarget set to true. More...
 
void removeAllEffectPasses ()
 Removes all effect passes. More...
 
void setIntermediateGeometry (Renderer &renderer, const QuadDescription &effectQuad)
 Sets the intermediate geometry for the effect. More...
 

Detailed Description

Blur effect renderer class.

See also
BlurEffect2D, NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D
Since
Kanzi 3.9.0

Member Function Documentation

◆ create()

static BlurEffectRenderer2DUniquePtr kanzi::BlurEffectRenderer2D::create ( BlurEffect2DSharedPtr  blurEffect)
static

Creates instances of BlurEffectRenderer2D.

Parameters
blurEffectThe BlurEffect2D instance on which this renderer is based.
Returns
BlurEffectRenderer2D instance.

◆ setRadius()

void kanzi::BlurEffectRenderer2D::setRadius ( float  radius)

Sets the pixel radius of the blur.

Parameters
radiusThe blur radius in pixels.

◆ setQuality()

void kanzi::BlurEffectRenderer2D::setQuality ( BlurEffect2D::Quality  quality)

Sets the quality of the blur.

Parameters
qualityThe quality level.

◆ setMaskedBlurEnabled()

void kanzi::BlurEffectRenderer2D::setMaskedBlurEnabled ( bool  enabled)

Sets the masked blur mode.

Parameters
enabledWhether the masked blur mode is enabled.

The documentation for this class was generated from the following file: