fastuidraw::PainterData Class Reference

A PainterData provides the data for how for a Painter to draw content. More...

#include <painter_data.hpp>

Classes
class	brush_value
	A brush_value stores the brush applied; it stores a pointer to a PainterBrushShader together with a PainterDataValue<PainterBrushShaderData>. If the pointer to the PainterBrushShader is null, then it indicates to use the standard brush shader, PainterBrushShaderSet::standard_brush(). More...

Public Member Functions
	PainterData (void)
template<typename T1 >
	PainterData (const T1 &r1)
template<typename T1 , typename T2 >
	PainterData (const T1 &r1, const T2 &r2)
template<typename T1 , typename T2 , typename T3 >
	PainterData (const T1 &r1, const T2 &r2, const T3 &r3)
void	make_packed (PainterPackedValuePool &pool)
PainterData &	set (const brush_value &value)
PainterData &	set (const PainterBrush *value)
PainterData &	set (const PainterCustomBrush &value)
PainterData &	set (const PainterDataValue< PainterBrushShaderData > &value)
PainterData &	set (const PainterDataValue< PainterItemShaderData > &value)
PainterData &	set (const PainterDataValue< PainterBlendShaderData > &value)

Public Attributes
PainterDataValue< PainterBlendShaderData >	m_blend_shader_data
brush_value	m_brush
PainterDataValue< PainterItemShaderData >	m_item_shader_data

Detailed Description

A PainterData provides the data for how for a Painter to draw content.

Definition at line 42 of file painter_data.hpp.

Constructor & Destructor Documentation

PainterData() [1/4]

fastuidraw::PainterData::PainterData ( void  )

inline

Ctor. Intitializes all fields as default nothings.

Definition at line 181 of file painter_data.hpp.

PainterData() [2/4]

template<typename T1 >

fastuidraw::PainterData::PainterData ( const T1 &  r1 )

inline

Ctor to initialize one field.

Parameters

r1	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.

Definition at line 191 of file painter_data.hpp.

PainterData() [3/4]

template<typename T1 , typename T2 >

fastuidraw::PainterData::PainterData ( const T1 &  r1, const T2 &  r2  )

inline

Ctor to initialize two fields.

Parameters

r1	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.
r2	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.

Definition at line 206 of file painter_data.hpp.

PainterData() [4/4]

template<typename T1 , typename T2 , typename T3 >

fastuidraw::PainterData::PainterData ( const T1 &  r1, const T2 &  r2, const T3 &  r3  )

inline

Ctor to initialize three fields.

Parameters

r1	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.
r2	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.
r3	calls one of the set() functions relying on C++ conversion and template logic to select the correct field to set.

Definition at line 225 of file painter_data.hpp.

Member Function Documentation

make_packed()

void fastuidraw::PainterData::make_packed ( PainterPackedValuePool &  pool )

inline

Call value::make_packed() on m_brush, m_item_shader_data, and m_blend_shader_data.

Parameters

pool	PainterPackedValuePool from which to create the packed value

Definition at line 315 of file painter_data.hpp.

set() [1/6]

PainterData& fastuidraw::PainterData::set ( const brush_value &  value )

inline

Sets m_brush

Definition at line 251 of file painter_data.hpp.

set() [2/6]

PainterData& fastuidraw::PainterData::set ( const PainterBrush *  value )

inline

Sets m_brush

Definition at line 261 of file painter_data.hpp.

set() [3/6]

PainterData& fastuidraw::PainterData::set ( const PainterCustomBrush &  value )

inline

Sets m_brush

Definition at line 271 of file painter_data.hpp.

set() [4/6]

PainterData& fastuidraw::PainterData::set ( const PainterDataValue< PainterBrushShaderData > &  value )

inline

Sets m_brush

Definition at line 281 of file painter_data.hpp.

set() [5/6]

PainterData& fastuidraw::PainterData::set ( const PainterDataValue< PainterItemShaderData > &  value )

inline

Sets m_item_shader_data

Definition at line 291 of file painter_data.hpp.

set() [6/6]

PainterData& fastuidraw::PainterData::set ( const PainterDataValue< PainterBlendShaderData > &  value )

inline

Sets m_blend_shader_data

Definition at line 301 of file painter_data.hpp.

Member Data Documentation

m_blend_shader_data

PainterDataValue<PainterBlendShaderData> fastuidraw::PainterData::m_blend_shader_data

value for blend shader data

Definition at line 245 of file painter_data.hpp.

m_brush

brush_value fastuidraw::PainterData::m_brush

value for brush (fixed-function or custom brush shading).

Definition at line 235 of file painter_data.hpp.

m_item_shader_data

PainterDataValue<PainterItemShaderData> fastuidraw::PainterData::m_item_shader_data

value for item shader data

Definition at line 240 of file painter_data.hpp.

---

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

• /home/kevin/fastuidraw.krogueintel/inc/fastuidraw/painter/shader_data/painter_data.hpp