Kanzi 3.9.10
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.
 
void setQuality (BlurEffect2D::Quality quality)
 Sets the quality of the blur.
 
void setRadius (float radius)
 Sets the pixel radius of the blur.
 
- Public Member Functions inherited from kanzi::NodeEffectRenderer2D
void applyEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const Matrix3x3 &worldTransform, const CompositionContentRequirements &requirements, TextureSharedPtr sourceContent)
 Applies the effect on the source content provided as texture.
 
void beginEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const Matrix3x3 &worldTransform, const CompositionContentRequirements &requirements)
 Begins the effect.
 
void blitEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const QuadDescription &effectQuad, const Matrix3x3 &transform, const Matrix4x4 *perspectiveMatrix, const Matrix4x4 *projectionMatrix, int blendMode, bool needsClear)
 Blits the effect to the current framebuffer.
 
void endEffect (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager)
 Ends the effect.
 
NodeEffect2DSharedPtr getEffect () const
 Get NodeEffect2D instance where this renderer has been instantiated from.
 
size_t getEffectPassCount () const
 Gets the number of effect passes.
 
bool isLayeredOnTop () const
 Whether a compatible effect renders logically on top of its source content.
 
bool isRenderEffectOnlyEnabled () const
 Whether the effect only mode is enabled.
 
void restoreResources ()
 Restores resources after the rendering context has been lost.
 
void setRenderEffectOnly (bool renderEffectOnly)
 Sets the render effect only mode.
 
virtual bool supportsBlitBlendMode (int blendMode)
 Whether the effect is compatible with a given blend mode.
 
virtual ~NodeEffectRenderer2D ()
 Declare NodeEffectRenderer2D as not movable nor copyable.
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Types inherited from kanzi::NodeEffectRenderer2D
using EffectPassContainer
 Container for effect passes.
 
- Protected Member Functions inherited from kanzi::NodeEffectRenderer2D
EffectPassaddEffectPass ()
 Adds an effect pass and gets a reference to that pass.
 
void beginInitialEffectPass (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const CompositionContentRequirements &requirements)
 Begins the initial effect pass (effect pass at index 0).
 
void blitEffectPass (int effectPassIndex, Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const QuadDescription &effectQuad, const Matrix3x3 &transform, const Matrix4x4 *perspectiveMatrix, const Matrix4x4 *projectionMatrix, int blendMode, bool needsClear)
 Blits the effect pass and handles the perspective transform if necessary.
 
void blitFinalEffectPass (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const 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.
 
void blitIntermediateEffectPass (int effectPassIndex, Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager)
 Blits the intermediate effect pass.
 
void clearRenderTarget (Renderer3D &renderer, CompositionStack &compositionStack, NativeFramebufferHandle framebufferHandle, ColorRGBA clearColor)
 Clears the native framebuffer with a given color.
 
void clearRenderTarget (Renderer3D &renderer, CompositionStack &compositionStack, TextureSharedPtr texture, ColorRGBA clearColor)
 Clears the render target texture with a given color.
 
void configureInitialEffectPass (Vector2 sourceContentSize)
 Configures the initial effect pass.
 
void endInitialEffectPass (CompositionStack &compositionStack)
 Ends the initial effect pass, whose index is 0.
 
void finalizeEffectPasses ()
 Finalizes the effect passes.
 
Vector2 getEffectInputTexelSize (int effectPassIndex, int inputIndex)
 Gets the texel size of the input effect pass texture in texture coordinates.
 
EffectPassgetEffectPass (int index)
 Gets a reference to the effect pass at a given index.
 
int getLastEffectPassIndex () const
 Gets the index of the last effect pass.
 
bool isInitialPassRenderTargetTemporary () const
 Whether the initial pass render target is temporary.
 
 NodeEffectRenderer2D (NodeEffect2DSharedPtr nodeEffect)
 Constructor.
 
virtual void onRenderEffectOnlyChanged ()
 Kanzi calls this when the render effect only mode changes.
 
void releaseEffectPassInputRenderTargets (EffectPass &currentEffectPass, CompositionManager *compositionManager)
 Releases those temporary render targets used by input that have EffectPass::Input::releaseRenderTarget set to true.
 
void removeAllEffectPasses ()
 Removes all user-added effect passes, but leaves the internal initial effect pass.
 
void setLayeredOnTop (bool layeredOnTop)
 Sets whether the effect is layered on top of the source content.
 
- Static Protected Attributes inherited from kanzi::NodeEffectRenderer2D
static constexpr int InitialEffectPassIndex
 Effect pass index for the initial pass.
 

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: