Kanzi  3.9.5
Kanzi Engine API
kanzi::NodeVisual2D::BrushState Struct Reference

State associated with brush rendering. More...

#include <kanzi/core.ui/node/node_visual2d.hpp>

Public Member Functions

void render (Renderer3D &renderer, const Matrix4x4 &transform, BrushRenderer &overrideBrushRenderer)
 Renders geometry using an override brush renderer. More...
 
void setGeometry (Domain *domain, const QuadDescription &quad, Vector2 tiling)
 Creates a quad geometry. More...
 
void setGeometry (Domain *domain, const FrameDescription &frame, Vector2 tiling)
 Creates a frame quad geometry. More...
 

Public Attributes

Brushbrush
 Brush instance. More...
 
BrushRendererPtr brushRenderer
 Brush renderer associated with the brush. More...
 
GeometrySharedPtr geometry
 Geometry instance. More...
 
optional< RectangleFloatunitQuadTargetRectangle
 Target rectangle for the unit quad if the unit quad is used, nullopt otherwise. More...
 

Detailed Description

State associated with brush rendering.

Since
Kanzi 3.9.5

Member Function Documentation

◆ render()

void kanzi::NodeVisual2D::BrushState::render ( Renderer3D renderer,
const Matrix4x4 transform,
BrushRenderer overrideBrushRenderer 
)

Renders geometry using an override brush renderer.

Parameters
rendererRenderer to use.
transformTransform for the quad.
overrideBrushRendererBrush renderer to use.

◆ setGeometry() [1/2]

void kanzi::NodeVisual2D::BrushState::setGeometry ( Domain domain,
const QuadDescription quad,
Vector2  tiling 
)

Creates a quad geometry.

Parameters
domainDomain to use.
quadQuad description.
tilingTexture tiling factors.

◆ setGeometry() [2/2]

void kanzi::NodeVisual2D::BrushState::setGeometry ( Domain domain,
const FrameDescription frame,
Vector2  tiling 
)

Creates a frame quad geometry.

Parameters
domainDomain to use.
frameFrame description.
tilingTexture tiling factors.

Member Data Documentation

◆ geometry

GeometrySharedPtr kanzi::NodeVisual2D::BrushState::geometry

Geometry instance.

◆ brush

Brush* kanzi::NodeVisual2D::BrushState::brush

Brush instance.

Not owned by the visual.

◆ brushRenderer

BrushRendererPtr kanzi::NodeVisual2D::BrushState::brushRenderer

Brush renderer associated with the brush.

◆ unitQuadTargetRectangle

optional<RectangleFloat> kanzi::NodeVisual2D::BrushState::unitQuadTargetRectangle

Target rectangle for the unit quad if the unit quad is used, nullopt otherwise.


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