#include <cairocolor.h>

Public Types
typedef uint32_t	value_type

Public Member Functions
unsigned char	ceil_clamp (int x)
unsigned char	floor_clamp (int x)
unsigned char	clamp (int x)
unsigned char	clamp (float x)
CairoColor &	operator+= (const CairoColor &rhs)
CairoColor &	operator-= (const CairoColor &rhs)
CairoColor &	operator*= (const float &rhs)
CairoColor &	operator/= (const float &rhs)
CairoColor	operator+ (const CairoColor &rhs) const
CairoColor	operator- (const CairoColor &rhs) const
CairoColor	operator* (const float &rhs) const
CairoColor	operator/ (const float &rhs) const
bool	operator== (const CairoColor &rhs) const
bool	operator!= (const CairoColor &rhs) const
CairoColor	operator~ () const
bool	is_valid () const
CairoColor	premult_alpha () const
CairoColor	demult_alpha () const
	CairoColor ()
	CairoColor (const unsigned char u)
	CairoColor (const unsigned char R, const unsigned char G, const unsigned char B, const unsigned char A=ceil)
	CairoColor (const CairoColor &c, const unsigned char A)
	CairoColor (const CairoColor &c)
	CairoColor (const Color &c)
	CairoColor (const CairoColorAccumulator &c)
	CairoColor (int r, int g, int b, int a)
value_type	get_pixel () const
unsigned char	get_a () const
unsigned char	get_r () const
unsigned char	get_g () const
unsigned char	get_b () const
unsigned char	get_alpha () const
const String	get_string (void) const
void	set_hex (String &str)
const String	get_hex () const
CairoColor &	set_r (const unsigned char x)
CairoColor &	set_g (const unsigned char x)
CairoColor &	set_b (const unsigned char x)
CairoColor &	set_a (const unsigned char x)
CairoColor &	set_alpha (const unsigned char x)
float	get_y () const
float	get_u () const
float	get_v () const
float	get_s () const
CairoColor &	set_yuv (const float &y, const float &u, const float &v)
CairoColor &	set_y (const float &y)
CairoColor &	set_u (const float &u)
CairoColor &	set_v (const float &v)
CairoColor &	set_uv (const float &u, const float &v)
CairoColor &	set_s (const float &x)
Angle	get_hue () const
Angle	get_uv_angle () const
CairoColor &	set_hue (const Angle &theta)
CairoColor &	set_uv_angle (const Angle &theta)
CairoColor &	rotate_uv (const Angle &theta)
CairoColor &	set_yuv (const float &y, const float &s, const Angle &theta)

Static Public Member Functions
static const String	char2hex (unsigned char c)
static unsigned char	hex2char (String s)
static CairoColor	YUV (const float &y, const float &u, const float &v, const unsigned char a=ceil)
static CairoColor	YUV (const float &y, const float &s, const Angle &theta, const unsigned char a=ceil)
static CairoColor	alpha ()
static CairoColor	black ()
static CairoColor	white ()
static CairoColor	gray ()
static CairoColor	magenta ()
static CairoColor	red ()
static CairoColor	green ()
static CairoColor	blue ()
static CairoColor	cyan ()
static CairoColor	yellow ()
static CairoColor	blend (CairoColor a, CairoColor b, float amount, Color::BlendMethod type=Color::BLEND_COMPOSITE)
static bool	is_onto (Color::BlendMethod x)
static bool	is_straight (Color::BlendMethod x)

Static Public Attributes
static const unsigned char	ceil = 255
static const unsigned char	floor = 0
static const float	range = CairoColor::ceil - CairoColor::floor
static const value_type	amask = 0xFF<<24
static const value_type	rmask = 0xFF<<16
static const value_type	gmask = 0xFF<<8
static const value_type	bmask = 0xFF

Friends
class	CairoColorAccumulator

Detailed Description

\ ARGB 32 bits Color class implementation \ for Cairo Image usage. \ Color channels are stored in a 32 bits value native endian aligened \ with this order A, R, G, B \ Operations over color channels \ that overflow or underflow the unsigned char value \ (get the value out of 0-255) aren't allowed and the \ value will remain at 0 or 255. Otherwise, there could \ be color cycling what will produce artifacts, since \ values outside 0-255 aren't allowed.

\ In this class color channels aren't alpha premultiplied \ When used on a alpha premultiplied surface the premultiplication \ and demultiplication has to be explicitly done by the user before \ and after being used on the Cairo Image surface.

Member Typedef Documentation

typedef uint32_t synfig::CairoColor::value_type

Constructor & Destructor Documentation

synfig::CairoColor::CairoColor ( )

inline

Referenced by alpha(), black(), blue(), cyan(), demult_alpha(), gray(), green(), magenta(), operator*(), operator+(), operator-(), operator/(), operator~(), premult_alpha(), red(), set_hex(), set_yuv(), white(), yellow(), and YUV().

synfig::CairoColor::CairoColor ( const unsigned char u )

inline

synfig::CairoColor::CairoColor	(	const unsigned char	R,
		const unsigned char	G,
		const unsigned char	B,
		const unsigned char	A = `ceil`
	)

inline

synfig::CairoColor::CairoColor	(	const CairoColor &	c,
		const unsigned char	A
	)

inline

References set_a().

synfig::CairoColor::CairoColor ( const CairoColor & c )

inline

synfig::CairoColor::CairoColor ( const Color & c )

inline

References synfig::Color::ceil, ceil, floor, synfig::Color::get_a(), synfig::Color::get_b(), synfig::Color::get_g(), synfig::Color::get_r(), set_a(), set_b(), set_g(), and set_r().

synfig::CairoColor::CairoColor ( const CairoColorAccumulator & c )

inline

References clamp(), range, set_a(), set_b(), set_g(), and set_r().

synfig::CairoColor::CairoColor	(	int	r,
		int	g,
		int	b,
		int	a
	)

inline

References clamp(), set_a(), set_b(), set_g(), and set_r().

Member Function Documentation

unsigned char synfig::CairoColor::ceil_clamp ( int x )

inline

References ceil.

Referenced by operator+=().

unsigned char synfig::CairoColor::floor_clamp ( int x )

inline

References floor.

Referenced by operator-=().

unsigned char synfig::CairoColor::clamp ( int x )

inline

References ceil, and floor.

Referenced by CairoColor(), clamp(), operator*=(), and operator/=().

unsigned char synfig::CairoColor::clamp ( float x )

inline

References clamp().

CairoColor& synfig::CairoColor::operator+= ( const CairoColor & rhs )

inline

References ceil_clamp(), get_a(), get_b(), get_g(), get_r(), set_a(), set_b(), set_g(), and set_r().

CairoColor& synfig::CairoColor::operator-= ( const CairoColor & rhs )

inline

References floor_clamp(), get_a(), get_b(), get_g(), get_r(), set_a(), set_b(), set_g(), and set_r().

CairoColor& synfig::CairoColor::operator*= ( const float & rhs )

inline

References clamp(), get_a(), get_b(), get_g(), get_r(), set_a(), set_b(), set_g(), and set_r().

CairoColor& synfig::CairoColor::operator/= ( const float & rhs )

inline

References clamp(), f, get_a(), get_b(), get_g(), get_r(), set_a(), set_b(), set_g(), and set_r().

CairoColor synfig::CairoColor::operator+ ( const CairoColor & rhs ) const

inline

References CairoColor().

CairoColor synfig::CairoColor::operator- ( const CairoColor & rhs ) const

inline

References CairoColor().

CairoColor synfig::CairoColor::operator* ( const float & rhs ) const

inline

References CairoColor().

CairoColor synfig::CairoColor::operator/ ( const float & rhs ) const

inline

References CairoColor().

bool synfig::CairoColor::operator== ( const CairoColor & rhs ) const

inline

References get_a(), get_b(), get_g(), and get_r().

bool synfig::CairoColor::operator!= ( const CairoColor & rhs ) const

inline

References get_a(), get_b(), get_g(), and get_r().

CairoColor synfig::CairoColor::operator~ ( ) const

inline

References CairoColor(), ceil, get_a(), get_b(), get_g(), and get_r().

bool synfig::CairoColor::is_valid ( ) const

inline

CairoColor synfig::CairoColor::premult_alpha ( ) const

inline

References CairoColor(), get_a(), get_b(), get_g(), get_r(), and range.

Referenced by Layer_Shade::accelerated_cairorender(), synfig::Layer_SphereDistort::accelerated_cairorender(), SpiralGradient::accelerated_cairorender(), FilledRect::accelerated_cairorender(), CurveGradient::accelerated_cairorender(), cairo_paint_with_alpha_operator(), synfig::cairorender(), synfig::CairoColorPrep::cook(), and synfig::Layer_Shape::feather_cairo_surface().

CairoColor synfig::CairoColor::demult_alpha ( ) const

inline

References alpha(), CairoColor(), get_a(), get_b(), get_g(), get_r(), and range.

Referenced by synfig::Layer_Bitmap::get_cairocolor(), and synfig::CairoColorPrep::uncook().

value_type synfig::CairoColor::get_pixel ( ) const

inline

unsigned char synfig::CairoColor::get_a ( ) const

inline

unsigned char synfig::CairoColor::get_r ( ) const

inline

unsigned char synfig::CairoColor::get_g ( ) const

inline

unsigned char synfig::CairoColor::get_b ( ) const

inline

unsigned char synfig::CairoColor::get_alpha ( ) const

inline

References get_a().

Referenced by cairo_png_mptr::cairo_png_mptr(), synfig::Target_Cairo::gamma_filter(), and synfig::Target_Cairo_Tile::gamma_filter().

const String synfig::CairoColor::get_string ( void ) const

References get_a(), and get_hex().

const String synfig::CairoColor::char2hex ( unsigned char c )

static

References ceil, and synfig::Color::real2hex().

Referenced by get_hex().

unsigned char synfig::CairoColor::hex2char ( String s )

static

References synfig::Color::hex2real().

void synfig::CairoColor::set_hex ( String & str )

References CairoColor(), synfig::Color::clamped(), and synfig::Color::set_hex().

const String synfig::CairoColor::get_hex ( ) const

inline

References char2hex(), get_b(), get_g(), and get_r().

Referenced by get_string().

CairoColor& synfig::CairoColor::set_r ( const unsigned char x )

inline

References rmask.

Referenced by synfig::blendfunc_ADD(), synfig::blendfunc_BRIGHTEN(), synfig::blendfunc_DIFFERENCE(), synfig::blendfunc_MULTIPLY(), synfig::blendfunc_SCREEN(), synfig::blendfunc_SUBTRACT(), cairo_png_mptr::cairo_png_mptr(), CairoColor(), synfig::Target_Cairo::gamma_filter(), synfig::Target_Cairo_Tile::gamma_filter(), operator*=(), operator+=(), operator-=(), and operator/=().

CairoColor& synfig::CairoColor::set_g ( const unsigned char x )

inline

References gmask.

Referenced by synfig::blendfunc_ADD(), synfig::blendfunc_BRIGHTEN(), synfig::blendfunc_DIFFERENCE(), synfig::blendfunc_MULTIPLY(), synfig::blendfunc_SCREEN(), synfig::blendfunc_SUBTRACT(), cairo_png_mptr::cairo_png_mptr(), CairoColor(), synfig::Target_Cairo::gamma_filter(), synfig::Target_Cairo_Tile::gamma_filter(), operator*=(), operator+=(), operator-=(), and operator/=().

CairoColor& synfig::CairoColor::set_b ( const unsigned char x )

inline

References bmask.

Referenced by synfig::blendfunc_ADD(), synfig::blendfunc_BRIGHTEN(), synfig::blendfunc_DIFFERENCE(), synfig::blendfunc_MULTIPLY(), synfig::blendfunc_SCREEN(), synfig::blendfunc_SUBTRACT(), cairo_png_mptr::cairo_png_mptr(), CairoColor(), synfig::Target_Cairo::gamma_filter(), synfig::Target_Cairo_Tile::gamma_filter(), operator*=(), operator+=(), operator-=(), and operator/=().

CairoColor& synfig::CairoColor::set_a ( const unsigned char x )

inline

References amask.

Referenced by synfig::blendfunc_ALPHA_BRIGHTEN(), synfig::blendfunc_ALPHA_DARKEN(), synfig::blendfunc_ALPHA_OVER(), synfig::blendfunc_BEHIND(), synfig::blendfunc_ONTO(), synfig::blendfunc_STRAIGHT(), synfig::blendfunc_STRAIGHT_ONTO(), CairoColor(), operator*=(), operator+=(), operator-=(), operator/=(), and set_alpha().

CairoColor& synfig::CairoColor::set_alpha ( const unsigned char x )

inline

References set_a().

float synfig::CairoColor::get_y ( ) const

inline

References synfig::EncodeYUV, get_b(), get_g(), get_r(), and range.

Referenced by set_u(), set_uv(), and set_v().

float synfig::CairoColor::get_u ( ) const

inline

References synfig::EncodeYUV, get_b(), get_g(), get_r(), and range.

Referenced by get_hue(), get_s(), rotate_uv(), set_s(), set_v(), and set_y().

float synfig::CairoColor::get_v ( ) const

inline

References synfig::EncodeYUV, get_b(), get_g(), get_r(), and range.

Referenced by get_hue(), get_s(), rotate_uv(), set_s(), set_u(), and set_y().

float synfig::CairoColor::get_s ( ) const

inline

References get_u(), and get_v().

Referenced by set_hue().

CairoColor& synfig::CairoColor::set_yuv	(	const float &	y,
		const float &	u,
		const float &	v
	)

inline

References CairoColor(), synfig::DecodeYUV, synfig::Color::set_b(), synfig::Color::set_g(), and synfig::Color::set_r().

Referenced by set_u(), set_uv(), set_v(), set_y(), and set_yuv().

CairoColor& synfig::CairoColor::set_y ( const float & y )

inline

References get_u(), get_v(), and set_yuv().

CairoColor& synfig::CairoColor::set_u ( const float & u )

inline

References get_v(), get_y(), and set_yuv().

CairoColor& synfig::CairoColor::set_v ( const float & v )

inline

References get_u(), get_y(), and set_yuv().

CairoColor& synfig::CairoColor::set_uv	(	const float &	u,
		const float &	v
	)

inline

References get_y(), and set_yuv().

Referenced by rotate_uv(), set_hue(), and set_s().

CairoColor& synfig::CairoColor::set_s ( const float & x )

inline

References get_u(), get_v(), and set_uv().

static CairoColor synfig::CairoColor::YUV	(	const float &	y,
		const float &	u,
		const float &	v,
		const unsigned char	a = `ceil`
	)

inlinestatic

References CairoColor().

Angle synfig::CairoColor::get_hue ( ) const

inline

References get_u(), and get_v().

Referenced by get_uv_angle().

Angle synfig::CairoColor::get_uv_angle ( ) const

inline

References get_hue().

CairoColor& synfig::CairoColor::set_hue ( const Angle & theta )

inline

References get_s(), and set_uv().

Referenced by set_uv_angle().

CairoColor& synfig::CairoColor::set_uv_angle ( const Angle & theta )

inline

References set_hue().

CairoColor& synfig::CairoColor::rotate_uv ( const Angle & theta )

inline

References get_u(), get_v(), and set_uv().

CairoColor& synfig::CairoColor::set_yuv	(	const float &	y,
		const float &	s,
		const Angle &	theta
	)

inline

References set_yuv().

static CairoColor synfig::CairoColor::YUV	(	const float &	y,
		const float &	s,
		const Angle &	theta,
		const unsigned char	a = `ceil`
	)

inlinestatic

References CairoColor().

static CairoColor synfig::CairoColor::alpha ( )

inlinestatic

References CairoColor(), and floor.

Referenced by synfig::Layer_SphereDistort::accelerated_cairorender(), synfig::blendfunc_COMPOSITE(), synfig::blendfunc_STRAIGHT(), demult_alpha(), and synfig::Layer_Bitmap::get_cairocolor().

static CairoColor synfig::CairoColor::black ( )

inlinestatic

References CairoColor(), and floor.

static CairoColor synfig::CairoColor::white ( )

inlinestatic

References CairoColor(), and ceil.

static CairoColor synfig::CairoColor::gray ( )

inlinestatic

References CairoColor(), and ceil.

static CairoColor synfig::CairoColor::magenta ( )

inlinestatic

References CairoColor(), ceil, and floor.

static CairoColor synfig::CairoColor::red ( )

inlinestatic

References CairoColor(), ceil, and floor.

static CairoColor synfig::CairoColor::green ( )

inlinestatic

References CairoColor(), ceil, and floor.

static CairoColor synfig::CairoColor::blue ( )

inlinestatic

References CairoColor(), ceil, and floor.

static CairoColor synfig::CairoColor::cyan ( )

inlinestatic

References CairoColor(), ceil, and floor.

static CairoColor synfig::CairoColor::yellow ( )

inlinestatic

References CairoColor(), ceil, and floor.

CairoColor synfig::CairoColor::blend	(	CairoColor	a,
		CairoColor	b,
		float	amount,
		Color::BlendMethod	type = `Color::BLEND_COMPOSITE`
	)

static

References synfig::Color::BLEND_END, synfig::blendfunc_OVERLAY< CairoColor >(), and COLOR_EPSILON.

Referenced by synfig::blendfunc_ALPHA_OVER(), synfig::blendfunc_BEHIND(), synfig::blendfunc_HARD_LIGHT(), synfig::blendfunc_OVERLAY< CairoColor >(), synfig::blendfunc_STRAIGHT_ONTO(), and synfig::Layer_Bitmap::get_cairocolor().

static bool synfig::CairoColor::is_onto ( Color::BlendMethod x )

inlinestatic

static bool synfig::CairoColor::is_straight ( Color::BlendMethod x )

inlinestatic

Friends And Related Function Documentation

friend class CairoColorAccumulator

friend

Member Data Documentation

const unsigned char synfig::CairoColor::ceil = 255

static

Referenced by blue(), CairoColor(), ceil_clamp(), char2hex(), clamp(), synfig::Color::Color(), cyan(), synfig::Layer_Shape::feather_cairo_surface(), gray(), green(), magenta(), operator~(), red(), white(), and yellow().

const unsigned char synfig::CairoColor::floor = 0

static

Referenced by alpha(), black(), blue(), CairoColor(), clamp(), synfig::Color::Color(), cyan(), floor_clamp(), green(), magenta(), red(), and yellow().

const float synfig::CairoColor::range = CairoColor::ceil - CairoColor::floor

static

Referenced by CairoColor(), demult_alpha(), get_u(), get_v(), get_y(), and premult_alpha().

const value_type synfig::CairoColor::amask = 0xFF<<24

static

Referenced by set_a().

const value_type synfig::CairoColor::rmask = 0xFF<<16

static

Referenced by set_r().

const value_type synfig::CairoColor::gmask = 0xFF<<8

static

Referenced by set_g().

const value_type synfig::CairoColor::bmask = 0xFF

static

Referenced by set_b().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation