All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::GlBrushRenderer Class Reference

OpenGL brush renderer specifics. More...

#include <kanzi/graphics_2d/gl_brush_renderer.hpp>

Inheritance diagram for kanzi::GlBrushRenderer:
kanzi::BrushRenderer kanzi::ColorBrushRenderer kanzi::MaterialBrushRenderer kanzi::TextureBrushRenderer kanzi::ContentBrushRenderer

Public Member Functions

 GlBrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual ~GlBrushRenderer ()
 Destructor. More...
 
MaterialSharedPtr acquireErrorMaterial ()
 Acquire error material for rendering. More...
 
void attachMaterial (MaterialSharedPtr material)
 Bind brush for rendering with given material. More...
 
virtual void restoreResourcesOverride () KZ_OVERRIDE
 BrushRenderer::restoreResourcesOverride() implementation. More...
 
GlRenderStategetRenderState ()
 Access render state. More...
 
const GlRenderStategetRenderState () const
 Access render state (const version). 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, ClipQuad &quad, const Matrix4x4 &transform) const
 Draw a brush using given quad. More...
 
void draw (Renderer3D &renderer, ClipQuad &quad, const Matrix3x3 &transform) const
 Overload for draw a brush using given quad. More...
 
void restoreResources ()
 Restore resources after suspend. 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...
 

Protected Attributes

MaterialSharedPtr m_material
 Currently selected material. More...
 
GlRenderState m_renderState
 Contained render state. More...
 
- Protected Attributes inherited from kanzi::BrushRenderer
size_t m_contentTextureHandle
 Render value handle. More...
 
size_t m_renderOpacityHandle
 Render value handle. More...
 

Additional Inherited Members

- Protected 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
 BrushRenderer (Brush *brush, Node *node)
 Constructor. More...
 
virtual void drawQuadOverride (Renderer3D &renderer, ClipQuad &quad, const Matrix4x4 &transform) const =0
 Draw a clip quad. More...
 
virtual void bindOverride (Renderer3D &renderer)=0
 BrushRenderer-specific bind implementation. More...
 
virtual void updateRenderOverride (bool forceOpaque, bool translucencyHint)=0
 BrushRenderer-specific opacity override implementation. 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...
 
RenderMode getRenderMode () const
 Get currently selected render mode. More...
 
bool hasRenderMode () const
 Tell if any (valid) render mode selection has been made. More...
 
void setRenderMode (RenderMode selection)
 Set render mode. More...
 

Detailed Description

OpenGL brush renderer specifics.

Constructor & Destructor Documentation

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

Constructor.

Parameters
nodeNode to attach to.
brushBrush to attach to.
virtual kanzi::GlBrushRenderer::~GlBrushRenderer ( )
inlinevirtual

Destructor.

Member Function Documentation

MaterialSharedPtr kanzi::GlBrushRenderer::acquireErrorMaterial ( )

Acquire error material for rendering.

To be used when the assigned material applicable.

void kanzi::GlBrushRenderer::attachMaterial ( MaterialSharedPtr  material)

Bind brush for rendering with given material.

Parameters
materialMaterial to use.
virtual void kanzi::GlBrushRenderer::restoreResourcesOverride ( )
virtual
GlRenderState* kanzi::GlBrushRenderer::getRenderState ( )
inline

Access render state.

Returns
Render state corresponding to this.
const GlRenderState* kanzi::GlBrushRenderer::getRenderState ( ) const
inline

Access render state (const version).

Returns
Render state corresponding to this.

Member Data Documentation

MaterialSharedPtr kanzi::GlBrushRenderer::m_material
protected

Currently selected material.

GlRenderState kanzi::GlBrushRenderer::m_renderState
protected

Contained render state.


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