kanzi::ContentBrushRenderer Class Reference

Content brush renderer class. More...

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

Inheritance diagram for kanzi::ContentBrushRenderer:
kanzi::GlBrushRenderer kanzi::BrushRenderer kanzi::CompositionBrushRenderer

Public Member Functions

virtual void bindOverride (Renderer3D &renderer) KZ_OVERRIDE
 BrushRenderer::bindOverride() implementation. More...
 
virtual void updateRenderOverride (bool forceOpaque, bool translucencyHint) KZ_OVERRIDE
 BrushRenderer::updateRenderOverride() implementation. More...
 
GraphicsBlendMode getBlendModeValue () const
 Gets the last used blend mode value. More...
 
float getRenderOpacityValue () const
 Gets the last used render opacity value. More...
 
TextureSharedPtr getContentTextureValue () const
 Gets the last used content texture value. More...
 
- Public Member Functions inherited from kanzi::GlBrushRenderer
 GlBrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual ~GlBrushRenderer ()
 Destructor. More...
 
MaterialSharedPtr acquireErrorMaterial ()
 Acquire error material for rendering. More...
 
- Public Member Functions inherited from kanzi::BrushRenderer
virtual ~BrushRenderer ()
 Destructor. 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...
 
void bind (Renderer3D &renderer)
 Bind brush renderer for rendering. More...
 
void draw (Renderer3D &renderer, const Geometry &quad, const Matrix4x4 &transform) const
 Draw a brush using given quad. More...
 
void draw (Renderer3D &renderer, const Geometry &quad, const Matrix3x3 &transform) const
 Overload for draw a brush using given quad. More...
 
void restoreResources ()
 Restore resources after sleep. More...
 
BrushgetBrush () const
 Access brush. More...
 
unsigned int getPropertyChangeCounter () const
 Access property change counter. More...
 
float getRenderOpacity () const
 Access opacity. More...
 
void setRenderOpacity (float opacity)
 Set opacity to use for next attach. More...
 
TextureSharedPtr getContentTexture () const
 Access content texture. More...
 
void setContentTexture (TextureSharedPtr texture)
 Set a content texture. More...
 
NodegetNode () const
 Access node. More...
 
RenderMode getRenderMode () const
 Get currently selected render mode. More...
 
bool hasRenderMode () const
 Tell if any (valid) render mode selection has been made. More...
 
bool hasOpaqueRenderMode () const
 Tell if selected render mode is opaque. More...
 

Static Public Member Functions

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

Protected Member Functions

 ContentBrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual void drawOverride (Renderer3D &renderer, const Geometry &geometry, const Matrix4x4 &transform) const KZ_OVERRIDE
 BrushRenderer::drawOverride() implementation. More...
 
virtual void restoreResourcesOverride () KZ_OVERRIDE
 BrushRenderer::restoreResourcesOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::BrushRenderer
 BrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
void setRenderMode (RenderMode selection)
 Set render mode. More...
 
bool isChangeCounterSame () const
 Check if property change counter matches that of the brush. More...
 
void updateChangeCounter ()
 Update property change counter to match brush. 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...
 

Detailed Description

Content brush renderer class.

Constructor & Destructor Documentation

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

Constructor.

Parameters
brushBrush to use.
nodeNode to attach to.

Member Function Documentation

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

Create a new content brush renderer.

Parameters
brushBrush to use.
nodeNode to attach to.
virtual void kanzi::ContentBrushRenderer::bindOverride ( Renderer3D renderer)
virtual
virtual void kanzi::ContentBrushRenderer::updateRenderOverride ( bool  forceOpaque,
bool  translucencyHint 
)
virtual
GraphicsBlendMode kanzi::ContentBrushRenderer::getBlendModeValue ( ) const
inline

Gets the last used blend mode value.

Returns
Blend mode.
float kanzi::ContentBrushRenderer::getRenderOpacityValue ( ) const
inline

Gets the last used render opacity value.

Returns
Floating point value.
TextureSharedPtr kanzi::ContentBrushRenderer::getContentTextureValue ( ) const
inline

Gets the last used content texture value.

Returns
Shared pointer to texture.
virtual void kanzi::ContentBrushRenderer::drawOverride ( Renderer3D renderer,
const Geometry geometry,
const Matrix4x4 transform 
) const
protectedvirtual
virtual void kanzi::ContentBrushRenderer::restoreResourcesOverride ( )
protectedvirtual

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