#include <painter_effect_brush.hpp>

Inheritance diagram for fastuidraw::PainterEffectBrushParams:

Public Member Functions
PainterEffectBrushParams &	apply_matrix (const float2x2 &m)

PainterEffectBrushParams &	apply_rotate (float angle)

PainterEffectBrushParams &	apply_shear (float sx, float sy)

PainterEffectBrushParams &	apply_translate (const vec2 &p)

PainterEffectBrushParams &	color (const vec4 &v)

PainterEffectBrushParams &	linear_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &start_p, const vec2 &end_p, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	no_gradient (void)

PainterEffectBrushParams &	no_repeat_window (void)

PainterEffectBrushParams &	no_transformation (void)

PainterEffectBrushParams &	no_transformation_matrix (void)

PainterEffectBrushParams &	no_transformation_translation (void)

PainterEffectBrushParams &	radial_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &start_p, float start_r, const vec2 &end_p, float end_r, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	radial_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &p, float r, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	repeat_window (const vec2 &pos, const vec2 &size, enum PainterBrush::spread_type_t x_mode=PainterBrush::spread_repeat, enum PainterBrush::spread_type_t y_mode=PainterBrush::spread_repeat)

PainterEffectBrushParams &	sweep_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &p, float theta, float F, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	sweep_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &p, float theta, enum PainterEnums::screen_orientation orientation, enum PainterEnums::rotation_orientation_t rotation_orientation, float F, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	sweep_gradient (const reference_counted_ptr< const ColorStopSequence > &cs, const vec2 &p, float theta, enum PainterEnums::screen_orientation orientation, enum PainterEnums::rotation_orientation_t rotation_orientation, enum PainterBrush::spread_type_t spread)

PainterEffectBrushParams &	transformation (const vec2 &p, const float2x2 &m)

PainterEffectBrushParams &	transformation_matrix (const float2x2 &m)

PainterEffectBrushParams &	transformation_translate (const vec2 &p)

Friends
class	PainterEffectBrush

Detailed Description

The PainterEffectParams derived object for PainterEffectBrush

Definition at line 58 of file painter_effect_brush.hpp.

Member Function Documentation

◆ apply_matrix()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::apply_matrix ( const float2x2 & m )

inline

Apply a shear to the transformation of the brush.

Parameters

m	matrix to which to apply

Definition at line 243 of file painter_effect_brush.hpp.

◆ apply_rotate()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::apply_rotate ( float angle )

inline

Apply a rotation to the transformation of the brush.

Parameters

angle in radians by which to rotate

Definition at line 266 of file painter_effect_brush.hpp.

◆ apply_shear()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::apply_shear	(	float	sx,
		float	sy
	)

inline

Apply a shear to the transformation of the brush.

Parameters

sx	scale factor in x-direction
sy	scale factor in y-direction

Definition at line 255 of file painter_effect_brush.hpp.

◆ apply_translate()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::apply_translate ( const vec2 & p )

inline

Apply a translation to the transformation of the brush.

Definition at line 276 of file painter_effect_brush.hpp.

◆ color()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::color ( const vec4 & v )

inline

Set the modulate color, default value is (1, 1, 1, 1), i.e. no modulation.

Definition at line 66 of file painter_effect_brush.hpp.

◆ linear_gradient()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::linear_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	start_p,
		const vec2 &	end_p,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a linear gradient.

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
start_p	start position of gradient
end_p	end position of gradient.
spread	specifies the gradient spread type

Definition at line 81 of file painter_effect_brush.hpp.

◆ no_gradient()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::no_gradient ( void )

inline

Sets the brush to not have a gradient.

Definition at line 210 of file painter_effect_brush.hpp.

◆ no_repeat_window()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::no_repeat_window ( void )

inline

Sets the brush to not have a repeat window

Definition at line 345 of file painter_effect_brush.hpp.

◆ no_transformation()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::no_transformation ( void )

inline

Sets the brush to have no transformation.

Definition at line 319 of file painter_effect_brush.hpp.

◆ no_transformation_matrix()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::no_transformation_matrix ( void )

inline

Sets the brush to have no matrix in its transformation.

Definition at line 309 of file painter_effect_brush.hpp.

◆ no_transformation_translation()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::no_transformation_translation ( void )

inline

Sets the brush to have no translation in its transformation.

Definition at line 299 of file painter_effect_brush.hpp.

◆ radial_gradient() [1/2]

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::radial_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	start_p,
		float	start_r,
		const vec2 &	end_p,
		float	end_r,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a radial gradient.

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
start_p	start position of gradient
start_r	starting radius of radial gradient
end_p	end position of gradient.
end_r	ending radius of radial gradient
spread	specifies the gradient spread type

Definition at line 100 of file painter_effect_brush.hpp.

◆ radial_gradient() [2/2]

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::radial_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	p,
		float	r,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a radial gradient. Provided as a conveniance, equivalent to

radial_gradient(cs, p, 0.0f, p, r, repeat);

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
p	start and end position of gradient
r	ending radius of radial gradient
spread	specifies the gradient spread type

Definition at line 122 of file painter_effect_brush.hpp.

◆ repeat_window()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::repeat_window	(	const vec2 &	pos,
		const vec2 &	size,
		enum PainterBrush::spread_type_t	x_mode = `PainterBrush::spread_repeat`,
		enum PainterBrush::spread_type_t	y_mode = `PainterBrush::spread_repeat`
	)

inline

Sets the brush to have a repeat window

Parameters

pos	location of repeat window
size	of repeat window
x_mode	spread mode for x-coordinate
y_mode	spread mode for y-coordinate

Definition at line 333 of file painter_effect_brush.hpp.

◆ sweep_gradient() [1/3]

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::sweep_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	p,
		float	theta,
		float	F,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a sweep gradient (directly).

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
p	position of gradient
theta	start angle of the sweep gradient, this value should be in the range [-PI, PI]
F	the repeat factor applied to the interpolate, the sign of F is used to determine the sign of the sweep gradient.
spread	specifies the gradient spread type

Definition at line 142 of file painter_effect_brush.hpp.

◆ sweep_gradient() [2/3]

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::sweep_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	p,
		float	theta,
		enum PainterEnums::screen_orientation	orientation,
		enum PainterEnums::rotation_orientation_t	rotation_orientation,
		float	F,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a sweep gradient where the sign is determined by a PainterEnums::screen_orientation and a PainterEnums::rotation_orientation_t.

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
p	position of gradient
theta	angle of the sweep gradient, this value should be in the range [-PI, PI]
F	the repeat factor applied to the interpolate, a negative reverses the orientation of the sweep.
orientation	orientation of the screen
rotation_orientation	orientation of the sweep
spread	specifies the gradient spread type

Definition at line 166 of file painter_effect_brush.hpp.

◆ sweep_gradient() [3/3]

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::sweep_gradient	(	const reference_counted_ptr< const ColorStopSequence > &	cs,
		const vec2 &	p,
		float	theta,
		enum PainterEnums::screen_orientation	orientation,
		enum PainterEnums::rotation_orientation_t	rotation_orientation,
		enum PainterBrush::spread_type_t	spread
	)

inline

Sets the brush to have a sweep gradient with a repeat factor of 1.0 and where the sign is determined by a PainterEnums::screen_orientation and a PainterEnums::rotation_orientation_t. Equivalent to

sweep_gradient(cs, p, theta, orientation, rotation_orientation, 1.0f, repeat);

Parameters

cs	color stops for gradient. If handle is invalid, then sets brush to not have a gradient.
p	position of gradient
theta	angle of the sweep gradient, this value should be in the range [-PI, PI]
orientation	orientation of the screen
rotation_orientation	orientation of the sweep
spread	specifies the gradient spread type

Definition at line 195 of file painter_effect_brush.hpp.

◆ transformation()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::transformation	(	const vec2 &	p,
		const float2x2 &	m
	)

inline

Sets the brush to have a matrix and translation in its transformation

Parameters

p	translation value for brush transformation
m	matrix value for brush transformation

Definition at line 289 of file painter_effect_brush.hpp.

◆ transformation_matrix()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::transformation_matrix ( const float2x2 & m )

inline

Sets the brush to have a matrix in its transformation.

Parameters

m	matrix value for brush transformation

Definition at line 232 of file painter_effect_brush.hpp.

◆ transformation_translate()

PainterEffectBrushParams& fastuidraw::PainterEffectBrushParams::transformation_translate ( const vec2 & p )

inline

Sets the brush to have a translation in its transformation.

Parameters

p	translation value for brush transformation

Definition at line 221 of file painter_effect_brush.hpp.

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

/home/kevin/fastuidraw.krogueintel/inc/fastuidraw/painter/effects/painter_effect_brush.hpp

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ apply_matrix()

◆ apply_rotate()

◆ apply_shear()

◆ apply_translate()

◆ color()

◆ linear_gradient()

◆ no_gradient()

◆ no_repeat_window()

◆ no_transformation()

◆ no_transformation_matrix()

◆ no_transformation_translation()

◆ radial_gradient() [1/2]

◆ radial_gradient() [2/2]

◆ repeat_window()

◆ sweep_gradient() [1/3]

◆ sweep_gradient() [2/3]

◆ sweep_gradient() [3/3]

◆ transformation()

◆ transformation_matrix()

◆ transformation_translate()