Node effect renderer class. More...

#include <kanzi/core.ui/node/node_effect_renderer2d.hpp>

Inheritance diagram for kanzi::NodeEffectRenderer2D:

Classes
struct	EffectPass
	Effect pass configuration. More...

struct	EffectRenderState
	Render state configuration to use with an effect pass. More...

Public Member Functions
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...

size_t	getEffectPassCount () const
	Gets the number of effect passes. More...

void	restoreResources ()
	Restores resources after the rendering context has been lost. More...

virtual	~NodeEffectRenderer2D ()
	Declare NodeEffectRenderer2D as not movable nor copyable. More...

Protected Types
using	EffectPassContainer = vector< EffectPass >
	Container for effect passes. More...

Protected Member Functions
EffectPass &	addEffectPass ()
	Adds an effect pass and gets a reference to that pass. More...

virtual void	beginEffectOverride (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager, const Matrix3x3 &worldTransform, Vector2 requiredSize, bool alphaRequired, bool depthRequired, bool stencilRequired)=0
	Begin effect. 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...

virtual void	blitEffectOverride (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager compositionManager, QuadDescription &effectQuad, const Matrix3x3 &transform, const Matrix4x4 perspectiveMatrix, const Matrix4x4 *projectionMatrix, int blendMode, bool needsClear)=0
	Blit effect to current framebuffer. 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...

virtual void	endEffectOverride (Renderer3D &renderer, CompositionStack &compositionStack, CompositionManager *compositionManager)=0
	End effect. 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...

EffectPass &	getEffectPass (int index)
	Gets a reference to the effect pass at a given index. 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...

virtual void	restoreResourcesOverride ()=0
	Restore resource after rendering context has been lost. More...

Detailed Description

Node effect renderer class.

See also: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ EffectPassContainer

using kanzi::NodeEffectRenderer2D::EffectPassContainer = vector<EffectPass>

protected

Container for effect passes.

Constructor & Destructor Documentation

◆ ~NodeEffectRenderer2D()

virtual kanzi::NodeEffectRenderer2D::~NodeEffectRenderer2D ( )

virtual

Declare NodeEffectRenderer2D as not movable nor copyable.

Destructor.

◆ NodeEffectRenderer2D()

kanzi::NodeEffectRenderer2D::NodeEffectRenderer2D ( NodeEffect2DSharedPtr nodeEffect )

explicitprotected

Constructor.

Parameters

nodeEffect NodeEffect2D instance associated with this renderer.

Member Function Documentation

◆ getEffect()

NodeEffect2DSharedPtr kanzi::NodeEffectRenderer2D::getEffect ( ) const

Get NodeEffect2D instance where this renderer has been instantiated from.

◆ beginEffect()

void kanzi::NodeEffectRenderer2D::beginEffect	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager,
		const Matrix3x3 &	worldTransform,
		Vector2	requiredSize,
		bool	alphaRequired,
		bool	depthRequired,
		bool	stencilRequired
	)

Begins the effect.

Call this function before rendering the source content for the effect.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
worldTransform	2D affine world transform used by the node.
requiredSize	Required size of the source content to be used by the effect.
alphaRequired	Whether the content requires alpha channel.
depthRequired	Whether the content requires depth buffer.
stencilRequired	Whether the content requires stencil buffer.

◆ endEffect()

void kanzi::NodeEffectRenderer2D::endEffect	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager
	)

Ends the effect.

Call this function after rendering the source content for the effect.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.

◆ blitEffect()

void kanzi::NodeEffectRenderer2D::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.

Call this function after NodeEffectRenderer2D::endEffect when you want to blit the effect to screen. You can use this function to implement perspective projection, if you provide the relevant matrices.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
effectQuad	Potentially clipped effect quad honoring the NodeEffect2D::getEffectQuadPadding to use for rendering the effect.
transform	2D affine transform to use for rendering the effect quad.
perspectiveMatrix	Optional perspective matrix to use.
projectionMatrix	Optional projection matrix to use when rendering with perspective transform.
blendMode	The blend mode to use for the effect blit.
needsClear	Whether the current render target needs to be cleared before rendering.

Since: Kanzi 3.9.1 data type of the blendMode parameter changed from GraphicsBlendMode to int.

◆ restoreResources()

void kanzi::NodeEffectRenderer2D::restoreResources ( )

Restores resources after the rendering context has been lost.

◆ getEffectPassCount()

size_t kanzi::NodeEffectRenderer2D::getEffectPassCount ( ) const

Gets the number of effect passes.

Returns: The number of effect passes.

◆ beginEffectOverride()

virtual void kanzi::NodeEffectRenderer2D::beginEffectOverride	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager,
		const Matrix3x3 &	worldTransform,
		Vector2	requiredSize,
		bool	alphaRequired,
		bool	depthRequired,
		bool	stencilRequired
	)

protectedpure virtual

Begin effect.

Should be called before the source content for the effect is rendered.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
worldTransform	2D affine world transform used by the node.
requiredSize	Required size of the source content to be used by the effect.
alphaRequired	Whether the content requires alpha channel.
depthRequired	Whether the content requires depth buffer.
stencilRequired	Whether the content requires stencil buffer.

Implemented in kanzi::OutlineEffectRenderer2D.

◆ endEffectOverride()

virtual void kanzi::NodeEffectRenderer2D::endEffectOverride	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager
	)

protectedpure virtual

End effect.

Should be called after the source content for the effect has been rendered.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.

Implemented in kanzi::OutlineEffectRenderer2D.

◆ blitEffectOverride()

virtual void kanzi::NodeEffectRenderer2D::blitEffectOverride	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager,
		QuadDescription &	effectQuad,
		const Matrix3x3 &	transform,
		const Matrix4x4 *	perspectiveMatrix,
		const Matrix4x4 *	projectionMatrix,
		int	blendMode,
		bool	needsClear
	)

protectedpure virtual

Blit effect to current framebuffer.

Should after NodeEffectRenderer2D::endEffect when the effect should be blitted to screen. Can be used to implement perspective projection if relevant matrices are provided.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
effectQuad	Potentially clipped effect quad honoring the NodeEffect2D::getEffectQuadPadding to use for rendering the effect.
transform	2D affine transform to use for rendering the effect quad.
perspectiveMatrix	Optional perspective matrix to use.
projectionMatrix	Optional projection matrix to use when rendering with perspective transform.
blendMode	The blend mode to use for the effect blit.
needsClear	Whether the current render target needs to be cleared before rendering.

Since: Kanzi 3.9.1 data type of the blendMode parameter changed from GraphicsBlendMode to int.

Implemented in kanzi::OutlineEffectRenderer2D.

◆ restoreResourcesOverride()

virtual void kanzi::NodeEffectRenderer2D::restoreResourcesOverride ( )

protectedpure virtual

Restore resource after rendering context has been lost.

Implemented in kanzi::OutlineEffectRenderer2D.

◆ clearRenderTarget() [1/2]

void kanzi::NodeEffectRenderer2D::clearRenderTarget	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		TextureSharedPtr	texture,
		ColorRGBA	clearColor
	)

protected

Clears the render target texture with a given color.

Parameters

renderer	Renderer3D to use.
compositionStack	CompositionStack to use.
texture	Render target texture to clear.
clearColor	Color to use for the clear.

◆ clearRenderTarget() [2/2]

void kanzi::NodeEffectRenderer2D::clearRenderTarget	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		NativeFramebufferHandle	framebufferHandle,
		ColorRGBA	clearColor
	)

protected

Clears the native framebuffer with a given color.

Parameters

renderer	Renderer3D to use.
compositionStack	CompositionStack to use.
framebufferHandle	Framebuffer handle to use.
clearColor	Color to use for the clear.

◆ addEffectPass()

EffectPass& kanzi::NodeEffectRenderer2D::addEffectPass ( )

protected

Adds an effect pass and gets a reference to that pass.

Adding an effect pass invalidates references to previously added effect passes. You must add at least two effect passes. The first pass renders the contents into a render target texture, and the last pass blits the effect result.

Returns: EffectPass reference to the just added effect pass.

◆ getLastEffectPassIndex()

int kanzi::NodeEffectRenderer2D::getLastEffectPassIndex ( ) const

protected

Gets the index of the last effect pass.

Returns: The index of the last effect pass or -1 if there are no effect passes.

◆ getEffectPass()

EffectPass& kanzi::NodeEffectRenderer2D::getEffectPass ( int index )

protected

Gets a reference to the effect pass at a given index.

Parameters

index Index of the effect pass.

Returns: Reference to EffectPass instance at the given index.

◆ removeAllEffectPasses()

void kanzi::NodeEffectRenderer2D::removeAllEffectPasses ( )

protected

Removes all effect passes.

◆ finalizeEffectPasses()

void kanzi::NodeEffectRenderer2D::finalizeEffectPasses ( )

protected

Finalizes the effect passes.

Call this function after you have added and configured all effect passes. This function sets EffectPass::Input::releaseRenderTarget and in debug build checks whether all render pass outputs are in use.

◆ beginInitialEffectPass()

void kanzi::NodeEffectRenderer2D::beginInitialEffectPass	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager,
		bool	alphaRequired,
		bool	depthRequired,
		bool	stencilRequired
	)

protected

Begins the initial effect pass (effect pass at index 0).

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
alphaRequired	Whether the content requires alpha channel.
depthRequired	Whether the content requires depth buffer.
stencilRequired	Whether the content requires stencil buffer.

◆ endInitialEffectPass()

void kanzi::NodeEffectRenderer2D::endInitialEffectPass ( CompositionStack & compositionStack )

protected

Ends the initial effect pass, whose index is 0.

Parameters

compositionStack CompositionStack to use.

◆ blitIntermediateEffectPass()

void kanzi::NodeEffectRenderer2D::blitIntermediateEffectPass	(	int	effectPassIndex,
		Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager
	)

protected

Blits the intermediate effect pass.

If intermediate effect passes exist, blit them in order starting from index 1 to getEffectPassCount() - 2.

Parameters

effectPassIndex	Index of the effect pass to use.
renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.

◆ blitFinalEffectPass()

void kanzi::NodeEffectRenderer2D::blitFinalEffectPass	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		CompositionManager *	compositionManager,
		QuadDescription &	effectQuad,
		const Matrix3x3 &	transform,
		const Matrix4x4 *	perspectiveMatrix,
		const Matrix4x4 *	projectionMatrix,
		int	blendMode,
		bool	needsClear
	)

protected

Blits the final effect pass, whose index is getEffectPassCount() - 1, and handles the perspective transform if necessary.

Parameters

renderer	Renderer to use.
compositionStack	CompositionStack to use.
compositionManager	CompositionManager to use.
effectQuad	Potentially clipped effect quad honoring the NodeEffect2D::getEffectQuadPadding to use for rendering the effect.
transform	2D affine transform to use for rendering the effect quad.
perspectiveMatrix	Optional perspective matrix to use.
projectionMatrix	Optional projection matrix to use when rendering with perspective transform.
blendMode	The blend mode to use for the effect blit.
needsClear	Whether the current render target needs to be cleared before rendering.

Since: Kanzi 3.9.1 data type of the blendMode parameter changed from GraphicsBlendMode to int.

◆ getEffectInputTexelSize()

Vector2 kanzi::NodeEffectRenderer2D::getEffectInputTexelSize	(	int	effectPassIndex,
		int	inputIndex
	)

protected

Gets the texel size of the input effect pass texture in texture coordinates.

You can call this function only after the source effect pass has obtained a valid render target.

Parameters

effectPassIndex	Effect pass index.
inputIndex	Input index.

Returns: Size of texel in texture coordinates.

◆ releaseEffectPassInputRenderTargets()

void kanzi::NodeEffectRenderer2D::releaseEffectPassInputRenderTargets	(	NodeEffectRenderer2D::EffectPass &	currentEffectPass,
		CompositionManager *	compositionManager
	)

protected

Releases those temporary render targets used by input that have EffectPass::Input::releaseRenderTarget set to true.

Parameters

currentEffectPass	Reference to the effect pass whose referenced render targets to release if necessary.
compositionManager	CompositionManager used to get the temporary render targets.

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

kanzi/core.ui/node/node_effect_renderer2d.hpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ EffectPassContainer

Constructor & Destructor Documentation

◆ ~NodeEffectRenderer2D()

◆ NodeEffectRenderer2D()

Member Function Documentation

◆ getEffect()

◆ beginEffect()

◆ endEffect()

◆ blitEffect()

◆ restoreResources()

◆ getEffectPassCount()

◆ beginEffectOverride()

◆ endEffectOverride()

◆ blitEffectOverride()

◆ restoreResourcesOverride()

◆ clearRenderTarget() [1/2]

◆ clearRenderTarget() [2/2]

◆ addEffectPass()

◆ getLastEffectPassIndex()

◆ getEffectPass()

◆ removeAllEffectPasses()

◆ finalizeEffectPasses()

◆ beginInitialEffectPass()

◆ endInitialEffectPass()

◆ blitIntermediateEffectPass()

◆ blitFinalEffectPass()

◆ getEffectInputTexelSize()

◆ releaseEffectPassInputRenderTargets()