Class Brush

Class Documentation

class Brush

Brush is used to declare how to fill or outline shapes, such as rectangles, paths or text. A brush is either a solid color or a linear gradient.

Public Functions

inline Brush()

Constructs a new brush that is a transparent color.

inline Brush(const Color &color)

Constructs a new brush that is of color color.

inline Color color() const

Returns the color of the brush. If the brush is a gradient, this function returns the color of the first stop.

inline Brush brighter(float factor) const

Returns a new version of this brush that has the brightness increased by the specified factor. This is done by calling Color::brighter on all the colors of this brush.

inline Brush darker(float factor) const

Returns a new version of this color that has the brightness decreased by the specified factor. This is done by calling Color::darker on all the colors of this brush.

inline Brush transparentize(float factor) const

Returns a new version of this brush with the opacity decreased by factor.

This is done by calling Color::transparentize on all the colors of this brush.

inline Brush with_alpha(float alpha) const

Returns a new version of this brush with the related color’s opacities set to alpha.

Friends

friend struct private_api::Property< Brush >
inline friend bool operator==(const Brush &a, const Brush &b)

Returns true if a is equal to b. If a holds a color, then b must also hold a color that is identical to a’s color. If it holds a gradient, then the gradients must be identical. Returns false if the brushes differ in what they hold or their respective color or gradient are not equal.

inline friend bool operator!=(const Brush &a, const Brush &b)

Returns false if is not equal to b; true otherwise.