kanzi::ColorBrushRenderer Class Reference

Color brush renderer class. More...

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

Inheritance diagram for kanzi::ColorBrushRenderer:

Public Member Functions
ColorRGBA	getColorValue ()
	Gets the last used color value.
Public Member Functions inherited from kanzi::BrushRenderer
MaterialSharedPtr	acquireErrorMaterial ()
	Acquires an error material for rendering.
void	attachMaterial (MaterialSharedPtr material)
	Attaches a custom material.
void	bind (Renderer3D &renderer)
	Binds a brush renderer for rendering.
void	bind (Renderer3D &renderer, PropertyObject *object)
	Binds a brush renderer for rendering.
void	draw (Renderer &renderer, const Geometry &quad, const Matrix3x3 &transform)
	Overload for drawing a brush using a given quad.
void	draw (Renderer &renderer, const Geometry &quad, const Matrix4x4 &transform)
	Draws a brush using a given quad.
optional< int >	getBlendModeOverride () const
	Gets the blend mode override value.
int	getBlendModeValue () const
	Gets the last used blend mode value.
Brush *	getBrush () const
	Gets the brush for which Kanzi created this brush renderer.
TextureSharedPtr	getContentTexture () const
	Gets the content texture used by the brush renderer.
MaterialSharedPtr	getMaterial () const
	Gets the currently set material for the renderer.
Node *	getNode () const
	Gets the attached node.
bool	getOpaquenessHint () const
	Gets the opaqueness hint value.
unsigned int	getPropertyChangeCounter () const
	Gets the brush property change counter.
RenderMode	getRenderMode () const
	Gets the currently selected render mode.
float	getRenderOpacity () const
	Gets the render opacity.
GlRenderState &	getRenderState ()
	Gets the internal render state.
void	invalidateRenderValues ()
	Invalidates all render values.
bool	isOpaque () const
	Indicates whether the rendered brush is opaque.
bool	isRenderable () const
	Indicates whether a brush is in a renderable state.
void	restoreResources ()
	Restores resources after sleep.
void	setBlendModeOverride (optional< int > blendMode)
	Sets the blend mode override value.
void	setContentTexture (TextureSharedPtr texture)
	Sets the content texture for the brush renderer.
void	setOpaquenessHint (bool value)
	Sets the opaqueness hint.
void	setRenderOpacity (float opacity)
	Sets the render opacity to use for the next attach.
void	updateRender ()
	Prepares a brush for rendering.
virtual	~BrushRenderer ()=default
	Destructor.

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

Protected Member Functions
bool	bindOverride (Renderer3D &renderer, PropertyObject *object) override
	BrushRenderer::bindOverride() implementation.
	ColorBrushRenderer (Brush *brush, Node *node)
	Constructor.
void	drawOverride (Renderer &renderer, const Geometry &geometry, const Matrix4x4 &transform) override
	BrushRenderer::drawOverride() implementation.
void	updateRenderOverride () override
	BrushRenderer::updateRenderOverride() implementation.
Protected Member Functions inherited from kanzi::BrushRenderer
	BrushRenderer (Brush *brush, Node *node)
	Constructor.
virtual bool	isChangeCounterSame ()
	Checks whether the property change counter matches that of the brush.
virtual void	restoreResourcesOverride ()
	BrushRenderer-specific restore resources implementation.
virtual void	setContentTextureOverride (TextureSharedPtr texture)
	BrushRenderer-specific update of the content texture.
void	setRenderMode (RenderMode selection)
	Sets the render mode.
virtual void	updateChangeCounter ()
	Updates the property change counter to match the counter value from the brush.

Protected Attributes
GlRenderState::HandleType	m_colorHandle
	Color render state handle.
Protected Attributes inherited from kanzi::BrushRenderer
Brush *	m_brush
	Brush attached to.
unsigned int	m_brushPropertyChangeCounter
	Property change counter to track brush.
TextureSharedPtr	m_contentTexture
	Content texture provided to the brush renderer from outside. For example, from Node2D.
GlRenderState::HandleType	m_contentTextureHandle
	Render value handle.
bool	m_isRenderable
	Indicates whether the last bind() call was successful and the brush can be rendered.
Node *	m_node
	Node attached to.
RenderMode	m_renderMode
	Currently used render mode (or none if not selected).
float	m_renderOpacity
	Render opacity provided to the brush renderer from outside. For example, from Node2D.
GlRenderState::HandleType	m_renderOpacityHandle
	Render value handle.
GlRenderState	m_renderState
	Contained render state.
GlRenderValueBinding	m_renderValueBinding
	Property binding handler.

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

Constructor & Destructor Documentation

ColorBrushRenderer()

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

inlineexplicitprotected

Constructor.

Parameters

brush	Brush to use.
node	Node to attach to.

Member Function Documentation

create()

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.

getColorValue()

ColorRGBA kanzi::ColorBrushRenderer::getColorValue

(

)

Gets the last used color value.

Returns

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

drawOverride()

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

overrideprotectedvirtual

BrushRenderer::drawOverride() implementation.

Implements kanzi::BrushRenderer.

updateRenderOverride()

void kanzi::ColorBrushRenderer::updateRenderOverride ( )

overrideprotectedvirtual

BrushRenderer::updateRenderOverride() implementation.

Implements kanzi::BrushRenderer.

bindOverride()

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

overrideprotectedvirtual

BrushRenderer::bindOverride() implementation.

Reimplemented from kanzi::BrushRenderer.

Member Data Documentation

m_colorHandle

GlRenderState::HandleType kanzi::ColorBrushRenderer::m_colorHandle

protected

Color render state handle.

Since

Kanzi 3.9.9

---

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

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