Content brush renderer class. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/content_brush_renderer.hpp>

Inheritance diagram for kanzi::ContentBrushRenderer:

Public Member Functions
TextureSharedPtr	getContentTextureValue () const
	Gets the last used content texture value. More...

MaterialSharedPtr	getMaterial () override
	Get currently set material for the renderer. More...

float	getRenderOpacityValue () const
	Gets the last used render opacity value. More...

Public Member Functions inherited from kanzi::GlBrushRenderer
MaterialSharedPtr	acquireErrorMaterial ()
	Acquire error material for rendering. More...

	GlBrushRenderer (Brush brush, Node node)
	Constructor. More...

	~GlBrushRenderer () override
	Destructor. More...

Public Member Functions inherited from kanzi::BrushRenderer
void	bind (Renderer3D &renderer)
	Bind brush renderer for rendering. More...

void	draw (Renderer &renderer, const Geometry &quad, const Matrix4x4 &transform)
	Draw a brush using given quad. More...

void	draw (Renderer &renderer, const Geometry &quad, const Matrix3x3 &transform)
	Overload for draw a brush using given quad. More...

int	getBlendModeValue ()
	Gets the last used blend mode value. More...

Brush *	getBrush () const
	Access brush. More...

TextureSharedPtr	getContentTexture () const
	Access content texture. More...

Node *	getNode () const
	Gets the attached node. More...

unsigned int	getPropertyChangeCounter () const
	Access property change counter. More...

RenderMode	getRenderMode () const
	Get currently selected render mode. More...

float	getRenderOpacity () const
	Access opacity. More...

bool	hasRenderMode () const
	Indicates whether a valid render mode is selected. More...

void	restoreResources ()
	Restore resources after sleep. More...

void	setContentTexture (TextureSharedPtr texture)
	Set a content texture. More...

void	setRenderOpacity (float opacity)
	Set opacity to use for next attach. More...

void	updateRender (optional< int > blendMode, bool translucencyHint)
	Called from Node2D::updateRender(). More...

virtual	~BrushRenderer ()=default
	Destructor. More...

Static Public Member Functions
static BrushRendererPtr	create (Brush brush, Node node)
	Create a new content brush renderer. More...

Protected Member Functions
void	bindOverride (Renderer3D &renderer) override
	BrushRenderer::bindOverride() implementation. More...

	ContentBrushRenderer (Brush brush, Node node)
	Constructor. More...

void	drawOverride (Renderer &renderer, const Geometry &geometry, const Matrix4x4 &transform) override
	BrushRenderer::drawOverride() implementation. More...

int	getBlendModeValueOverride () override
	BrushRenderer::getBlendModeValueOverride() implementation. More...

int	getContentBrushBlendMode () const
	Gets the blend mode as specified in the content brush. More...

void	recreateRenderValues ()
	Recreate all render value structures from current material. More...

void	restoreResourcesOverride () override
	BrushRenderer::restoreResourcesOverride() implementation. More...

void	setBlendModeFallback (bool isOpaque)
	Sets the fallback blend mode. More...

void	setBlendModeOverride (optional< int > blendMode)
	Sets the override blend mode. More...

void	updateRenderOverride (optional< int > blendMode, bool translucencyHint) override
	BrushRenderer::updateRenderOverride() implementation. More...

Protected Member Functions inherited from kanzi::BrushRenderer
	BrushRenderer (Brush brush, Node node)
	Constructor. More...

bool	isChangeCounterSame () const
	Checks whether the property change counter matches that of the brush. More...

virtual void	setContentTextureOverride (TextureSharedPtr texture)
	BrushRenderer-specific update of the content texture. More...

void	setRenderMode (RenderMode selection)
	Set render mode. More...

void	updateChangeCounter ()
	Updates property change counter to match the counter value from brush. More...

Protected Attributes
int	m_blendModeFallback
	Blend mode fallback. More...

optional< int >	m_blendModeOverride
	Blend mode override. More...

BlendModeValuePropertyNotificationHandler	m_blendModeProperty
	Property listener for blend mode. More...

GlBlendModeRenderValue	m_blendModeValue
	Render value. More...

GlRenderValue< TextureSharedPtr >	m_contentTextureValue
	Render value. More...

MaterialSharedPtr	m_material
	Currently selected material. More...

GlRenderValue< float >	m_renderOpacityValue
	Render value. More...

Protected Attributes inherited from kanzi::BrushRenderer
Brush *	m_brush
	Brush attached to. More...

unsigned int	m_brushPropertyChangeCounter
	Property change counter to track brush. More...

TextureSharedPtr	m_contentTexture
	Content texture provided to the brush renderer from outside, e.g. from Node2D. More...

Node *	m_node
	Node attached to. More...

RenderMode	m_renderMode
	Currently used render mode (or none if not selected). More...

float	m_renderOpacity
	Opacity to issue on attach. More...

Additional Inherited Members
Public Types inherited from kanzi::BrushRenderer
enum	RenderMode { RenderModeNone, RenderModeContent, RenderModeNoContent }
	Enum signifying currently selected render mode. More...

Detailed Description

Content brush renderer class.

Kanzi uses this class both as the class itself, and as a base class for all brush renderers that can handle content but do not need a complete render state.

See also: ColorBrushRenderer, TextureBrushRenderer

Constructor & Destructor Documentation

◆ ContentBrushRenderer()

kanzi::ContentBrushRenderer::ContentBrushRenderer	(	Brush *	brush,
		Node *	node
	)

inlineexplicitprotected

Constructor.

Parameters

brush	Brush to use.
node	Node to attach to.

Member Function Documentation

◆ create()

static BrushRendererPtr kanzi::ContentBrushRenderer::create	(	Brush *	brush,
		Node *	node
	)

static

Create a new content brush renderer.

Parameters

brush	Brush to use.
node	Node to attach to.

◆ getRenderOpacityValue()

float kanzi::ContentBrushRenderer::getRenderOpacityValue ( ) const

inline

Gets the last used render opacity value.

Returns: Floating point value.

◆ getContentTextureValue()

TextureSharedPtr kanzi::ContentBrushRenderer::getContentTextureValue ( ) const

inline

Gets the last used content texture value.

Returns: Shared pointer to texture.

◆ getMaterial()

MaterialSharedPtr kanzi::ContentBrushRenderer::getMaterial ( )

inlineoverridevirtual

Get currently set material for the renderer.

Returns: Shared pointer to the material that it currently set for the brush renderer. If not set, returns nullptr.

Reimplemented from kanzi::BrushRenderer.

◆ bindOverride()

void kanzi::ContentBrushRenderer::bindOverride ( Renderer3D & renderer )

overrideprotectedvirtual

BrushRenderer::bindOverride() implementation.

Implements kanzi::BrushRenderer.

Reimplemented in kanzi::TextureBrushRenderer.

◆ drawOverride()

void kanzi::ContentBrushRenderer::drawOverride	(	Renderer &	renderer,
		const Geometry &	geometry,
		const Matrix4x4 &	transform
	)

overrideprotectedvirtual

BrushRenderer::drawOverride() implementation.

Implements kanzi::BrushRenderer.

Reimplemented in kanzi::TextureBrushRenderer.

◆ restoreResourcesOverride()

void kanzi::ContentBrushRenderer::restoreResourcesOverride ( )

overrideprotectedvirtual

BrushRenderer::restoreResourcesOverride() implementation.

Implements kanzi::BrushRenderer.

Reimplemented in kanzi::TextureBrushRenderer.

◆ updateRenderOverride()

void kanzi::ContentBrushRenderer::updateRenderOverride	(	optional< int >	blendMode,
		bool	translucencyHint
	)

overrideprotectedvirtual

BrushRenderer::updateRenderOverride() implementation.

Implements kanzi::BrushRenderer.

Reimplemented in kanzi::TextureBrushRenderer.

◆ getBlendModeValueOverride()

int kanzi::ContentBrushRenderer::getBlendModeValueOverride ( )

overrideprotectedvirtual

BrushRenderer::getBlendModeValueOverride() implementation.

Implements kanzi::BrushRenderer.

◆ getContentBrushBlendMode()

int kanzi::ContentBrushRenderer::getContentBrushBlendMode ( ) const

protected

Gets the blend mode as specified in the content brush.

Returns: Blend mode to use when rendering.

Since: Kanzi 3.9.1

◆ setBlendModeOverride()

void kanzi::ContentBrushRenderer::setBlendModeOverride ( optional< int > blendMode )

inlineprotected

Sets the override blend mode.

Parameters

blendMode Blend mode override.

Since: Kanzi 3.9.1

◆ setBlendModeFallback()

void kanzi::ContentBrushRenderer::setBlendModeFallback ( bool isOpaque )

inlineprotected

Sets the fallback blend mode.

Parameters

isOpaque If the fallback blend mode to set is opaque, true, otherwise false.

Since: Kanzi 3.9.1

◆ recreateRenderValues()

void kanzi::ContentBrushRenderer::recreateRenderValues ( )

protected

Recreate all render value structures from current material.

Since: Kanzi 3.9.1 protection changed from private to protected.

Member Data Documentation

◆ m_material

MaterialSharedPtr kanzi::ContentBrushRenderer::m_material

protected

Currently selected material.

◆ m_blendModeOverride

optional<int> kanzi::ContentBrushRenderer::m_blendModeOverride

protected

Blend mode override.

Since: Kanzi 3.9.1

◆ m_blendModeFallback

int kanzi::ContentBrushRenderer::m_blendModeFallback

protected

Blend mode fallback.

Since: Kanzi 3.9.1

◆ m_blendModeValue

GlBlendModeRenderValue kanzi::ContentBrushRenderer::m_blendModeValue

protected

Render value.

Since: Kanzi 3.9.1 data type changed from GlRenderValue<GraphicsBlendMode> to GlBlendModeRenderValue.

◆ m_contentTextureValue

GlRenderValue<TextureSharedPtr> kanzi::ContentBrushRenderer::m_contentTextureValue

protected

Render value.

◆ m_renderOpacityValue

GlRenderValue<float> kanzi::ContentBrushRenderer::m_renderOpacityValue

protected

Render value.

◆ m_blendModeProperty

BlendModeValuePropertyNotificationHandler kanzi::ContentBrushRenderer::m_blendModeProperty

protected

Property listener for blend mode.

Since: Kanzi 3.9.1 data type changed from RenderValuePropertyNotificationHandler<GraphicsBlendMode> to BlendModeValuePropertyNotificationHandler.

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

kanzi/core.ui/platform/graphics_backend/gl/content_brush_renderer.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ContentBrushRenderer()

Member Function Documentation

◆ create()

◆ getRenderOpacityValue()

◆ getContentTextureValue()

◆ getMaterial()

◆ bindOverride()

◆ drawOverride()

◆ restoreResourcesOverride()

◆ updateRenderOverride()

◆ getBlendModeValueOverride()

◆ getContentBrushBlendMode()

◆ setBlendModeOverride()

◆ setBlendModeFallback()

◆ recreateRenderValues()

Member Data Documentation

◆ m_material

◆ m_blendModeOverride

◆ m_blendModeFallback

◆ m_blendModeValue

◆ m_contentTextureValue

◆ m_renderOpacityValue

◆ m_blendModeProperty