Kanzi  3.9.4
Kanzi Engine API
kanzi::GlBrushRenderer Class Reference

OpenGL brush renderer specifics. More...

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

Inheritance diagram for kanzi::GlBrushRenderer:
[legend]

Public Member Functions

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...
 
BrushgetBrush () const
 Access brush. More...
 
TextureSharedPtr getContentTexture () const
 Access content texture. More...
 
virtual MaterialSharedPtr getMaterial ()
 Get currently set material for the renderer. More...
 
NodegetNode () 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 forceOpaque, bool translucencyHint)
 Called from Node2D::updateRender(). More...
 
virtual ~BrushRenderer ()=default
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BrushRenderer
enum  RenderMode { RenderModeNone, RenderModeContent, RenderModeNoContent }
 Enum signifying currently selected render mode. More...
 
- Protected Member Functions inherited from kanzi::BrushRenderer
virtual void bindOverride (Renderer3D &renderer)=0
 BrushRenderer-specific bind implementation. More...
 
 BrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual void drawOverride (Renderer &renderer, const Geometry &geometry, const Matrix4x4 &transform)=0
 Draw geometry using the brush. More...
 
virtual int getBlendModeValueOverride ()=0
 BrushRenderer-specific acquisition of last-used blend mode. More...
 
bool isChangeCounterSame () const
 Checks whether the property change counter matches that of the brush. More...
 
virtual void restoreResourcesOverride ()=0
 BrushRenderer-specific restore resources implementation. More...
 
void setRenderMode (RenderMode selection)
 Set render mode. More...
 
void updateChangeCounter ()
 Updates property change counter to match the counter value from brush. More...
 
virtual void updateRenderOverride (optional< int > blendMode, bool forceOpaque, bool translucencyHint)=0
 BrushRenderer-specific opacity override implementation. More...
 
- Protected Attributes inherited from kanzi::BrushRenderer
Brushm_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...
 
Nodem_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...
 

Detailed Description

OpenGL brush renderer specifics.

Constructor & Destructor Documentation

◆ GlBrushRenderer()

kanzi::GlBrushRenderer::GlBrushRenderer ( Brush brush,
Node node 
)
inlineexplicit

Constructor.

Parameters
nodeNode to attach to.
brushBrush to attach to.

◆ ~GlBrushRenderer()

kanzi::GlBrushRenderer::~GlBrushRenderer ( )
inlineoverride

Destructor.

Member Function Documentation

◆ acquireErrorMaterial()

MaterialSharedPtr kanzi::GlBrushRenderer::acquireErrorMaterial ( )

Acquire error material for rendering.

To be used when the assigned material applicable.


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