Color brush renderer class. More...

#include <kanzi/core.ui/platform/graphics_backend/nogl/color_brush_renderer.hpp>

Inheritance diagram for kanzi::ColorBrushRenderer:

Public Member Functions
ColorRGBA	getColorValue ()
	Gets the last used color value. More...

Public Member Functions inherited from kanzi::BrushRenderer
MaterialSharedPtr	acquireErrorMaterial ()
	Acquires an error material for rendering. More...

void	attachMaterial (MaterialSharedPtr material)
	Attaches a custom material. More...

void	bind (Renderer3D &renderer, PropertyObject *object)
	Binds a brush renderer for rendering. More...

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
	Gets the brush for which Kanzi created this brush renderer. More...

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

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

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

unsigned int	getPropertyChangeCounter () const
	Gets the brush property change counter. More...

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

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

GlRenderState &	getRenderState ()
	Gets the internal render state. More...

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

void	invalidateRenderValues ()
	Invalidates all render values. 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 color brush renderer. More...

static BrushRendererPtr	create (Brush brush, Node node)
	Create a new color brush renderer. More...

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

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

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

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

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

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

void	setContentTextureOverride (TextureSharedPtr texture) override
	BrushRenderer::setContentTextureOverride() implementation. More...

void	updateRenderMode ()
	Updates ColorBrushRenderer render mode in accordance with brush parameters. More...

void	updateRenderOverride (optional< int > blendMode, bool translucencyHint) override
	BrushRenderer::updateRenderOverride() implementation. 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...

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

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

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

Additional Inherited Members
Public Types inherited from kanzi::BrushRenderer
enum	RenderMode { RenderModeNone, RenderModeContent, RenderModeNoContent }
	Enum signifying currently selected render mode. 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. For example, from Node2D. More...

GlRenderState::HandleType	m_contentTextureHandle
	Render value handle. 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...

GlRenderState::HandleType	m_renderOpacityHandle
	Render value handle. More...

GlRenderState	m_renderState
	Contained render state. More...

GlRenderValueBinding	m_renderValueBinding
	Property binding handler. More...

Detailed Description

Color brush renderer class.

Since: Kanzi 3.9.1 changed to use KANZI_COREUI_API and base class type changed from GlBrushRenderer to ContentBrushRenderer.; Kanzi 3.9.7 changed the base class from ContentBrushRenderer to BrushRenderer.; Kanzi 3.9.1 changed to use KANZI_COREUI_API.

Constructor & Destructor Documentation

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

inlineexplicitprotected

Constructor.

Parameters

brush	Brush to use.
node	Node to attach to.

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

inlineexplicitprotected

Constructor.

Parameters

brush	Brush to use.
node	Node to attach to.

Member Function Documentation

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

static

Create a new color brush renderer.

Parameters

brush	Brush to use.
node	Node to attach to.

ColorRGBA kanzi::ColorBrushRenderer::getColorValue ( )

Gets the last used color value.

Returns: The last color that the renderer used, or transparent black.

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

overrideprotectedvirtual

BrushRenderer::drawOverride() implementation.

Implements kanzi::BrushRenderer.

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

overrideprotectedvirtual

BrushRenderer::updateRenderOverride() implementation.

Implements kanzi::BrushRenderer.

void kanzi::ColorBrushRenderer::setContentTextureOverride ( TextureSharedPtr texture )

overrideprotectedvirtual

BrushRenderer::setContentTextureOverride() implementation.

Reimplemented from kanzi::BrushRenderer.

void kanzi::ColorBrushRenderer::updateRenderMode ( )

protected

Updates ColorBrushRenderer render mode in accordance with brush parameters.

Since: Kanzi 3.9.5

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

static

Create a new color brush renderer.

Parameters

brush	Brush to use.
node	Node to attach to.

void kanzi::ColorBrushRenderer::bindOverride	(	Renderer3D &	renderer,
		PropertyObject *	object
	)

overrideprotectedvirtual

BrushRenderer::bindOverride() implementation.

Reimplemented from kanzi::BrushRenderer.

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

overrideprotectedvirtual

BrushRenderer::drawOverride() implementation.

Implements kanzi::BrushRenderer.

void kanzi::ColorBrushRenderer::restoreResourcesOverride ( )

overrideprotectedvirtual

BrushRenderer::restoreResourcesOverride() implementation.

Reimplemented from kanzi::BrushRenderer.

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

overrideprotectedvirtual

BrushRenderer::updateRenderOverride() implementation.

Implements kanzi::BrushRenderer.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation