Kanzi Framework  3.9.0
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 (Renderer3D &renderer, const Geometry &quad, const Matrix4x4 &transform)
 Draw a brush using given quad. More...
 
void draw (Renderer3D &renderer, const Geometry &quad, const Matrix3x3 &transform)
 Overload for draw a brush using given quad. 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
 Access 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 hasOpaqueRenderMode () const
 Tell if selected render mode is opaque. More...
 
bool hasRenderMode () const
 Tell if any (valid) render mode selection has been made. 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 (bool forceOpaque, bool translucencyHint)
 Called from Node2D::updateRender(), prepare brush for rendering. More...
 
void updateRender (bool forceOpaque)
 Default parameter override for updateRender(). More...
 
void updateRender ()
 Default parameter override for updateRender(). More...
 
virtual ~BrushRenderer ()
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BrushRenderer
enum  RenderMode {
  RenderModeNone, RenderModeInvalid, RenderModeOpaqueNoContent, RenderModeTranslucentNoContent,
  RenderModeOpaque, RenderModeTranslucent
}
 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 (Renderer3D &renderer, const Geometry &geometry, const Matrix4x4 &transform)=0
 Draw a clip quad. More...
 
bool isChangeCounterSame () const
 Check if 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 ()
 Update property change counter to match brush. More...
 
virtual void updateRenderOverride (bool forceOpaque, bool translucencyHint)=0
 BrushRenderer-specific opacity override implementation. 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: