Kanzi  3.9.7
Kanzi Engine API
kanzi::CompositionBrushRenderer Class Reference

OpenGL texture brush renderer class. More...

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

Inheritance diagram for kanzi::CompositionBrushRenderer:
[legend]

Static Public Member Functions

static BrushRendererPtr create (Brush *brush, Node *node)
 Create a new composition brush renderer. More...
 
- Static Public Member Functions inherited from kanzi::ContentBrushRenderer
static BrushRendererPtr create (Brush *brush, Node *node)
 Creates a content brush renderer. More...
 

Protected Member Functions

 CompositionBrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ContentBrushRenderer
 ContentBrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
void drawOverride (Renderer &renderer, const Geometry &geometry, const Matrix4x4 &transform) override
 BrushRenderer::drawOverride() implementation. More...
 
void updateRenderOverride (optional< int > blendMode, bool translucencyHint) override
 BrushRenderer::updateRenderOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::BrushRenderer
virtual void bindOverride (Renderer3D &renderer, PropertyObject *object)
 BrushRenderer-specific bind implementation. More...
 
 BrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual bool isChangeCounterSame ()
 Checks whether the property change counter matches that of the brush. More...
 
virtual void restoreResourcesOverride ()
 BrushRenderer-specific restore resources implementation. More...
 
virtual void setContentTextureOverride (TextureSharedPtr texture)
 BrushRenderer-specific update of the content texture. 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...
 
- 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...
 
BrushgetBrush () 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...
 
NodegetNode () 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...
 
GlRenderStategetRenderState ()
 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...
 
- 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. For example, from Node2D. More...
 
GlRenderState::HandleType m_contentTextureHandle
 Render value handle. 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...
 
GlRenderState::HandleType m_renderOpacityHandle
 Render value handle. More...
 
GlRenderState m_renderState
 Contained render state. More...
 
GlRenderValueBinding m_renderValueBinding
 Property binding handler. More...
 

Detailed Description

OpenGL texture brush renderer class.

Constructor & Destructor Documentation

kanzi::CompositionBrushRenderer::CompositionBrushRenderer ( Brush brush,
Node node 
)
inlineexplicitprotected

Constructor.

Parameters
brushBrush to use.
nodeNode to attach to.

Member Function Documentation

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

Create a new composition brush renderer.

Parameters
brushBrush to use.
nodeNode to attach to.

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