PixelARGB Class Reference

Represents a 32-bit ARGB pixel with premultiplied alpha, and can perform compositing operations with it. More...

List of all members.

Public Types
enum	{ indexA = 3, indexR = 2, indexG = 1, indexB = 0 }
	The indexes of the different components in the byte layout of this type of colour. More...
Public Member Functions
	PixelARGB () throw ()
	Creates a pixel without defining its colour.
	~PixelARGB () throw ()
	PixelARGB (const uint32 argb_) throw ()
	Creates a pixel from a 32-bit argb value.
forcedinline uint32	getARGB () const throw ()
forcedinline uint32	getRB () const throw ()
forcedinline uint32	getAG () const throw ()
forcedinline uint8	getAlpha () const throw ()
forcedinline uint8	getRed () const throw ()
forcedinline uint8	getGreen () const throw ()
forcedinline uint8	getBlue () const throw ()
forcedinline void	blend (const PixelARGB &src) throw ()
	Blends another pixel onto this one.
forcedinline void	blend (const PixelAlpha &src) throw ()
	Blends another pixel onto this one.
forcedinline void	blend (const PixelRGB &src) throw ()
	Blends another pixel onto this one.
template<class Pixel >
forcedinline void	blend (const Pixel &src, uint32 extraAlpha) throw ()
	Blends another pixel onto this one, applying an extra multiplier to its opacity.
template<class Pixel >
forcedinline void	tween (const Pixel &src, const uint32 amount) throw ()
	Blends another pixel with this one, creating a colour that is somewhere between the two, as specified by the amount.
template<class Pixel >
forcedinline void	set (const Pixel &src) throw ()
	Copies another pixel colour over this one.
forcedinline void	setAlpha (const uint8 newAlpha) throw ()
	Replaces the colour's alpha value with another one.
forcedinline void	multiplyAlpha (int multiplier) throw ()
	Multiplies the colour's alpha value with another one.
forcedinline void	multiplyAlpha (const float multiplier) throw ()
void	setARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) throw ()
	Sets the pixel's colour from individual components.
forcedinline void	premultiply () throw ()
	Premultiplies the pixel's RGB values by its alpha.
forcedinline void	unpremultiply () throw ()
	Unpremultiplies the pixel's RGB values.
forcedinline void	desaturate () throw ()

---

Detailed Description

Represents a 32-bit ARGB pixel with premultiplied alpha, and can perform compositing operations with it.

This is used internally by the imaging classes.

See also:

PixelRGB

---

Member Enumeration Documentation

anonymous enum

The indexes of the different components in the byte layout of this type of colour.

Enumerator:

indexA
indexR
indexG
indexB

---

Constructor & Destructor Documentation

PixelARGB::PixelARGB

(

)

throw ()

Creates a pixel without defining its colour.

PixelARGB::~PixelARGB

(

)

throw ()

PixelARGB::PixelARGB

(

const uint32

argb_

)

throw ()

Creates a pixel from a 32-bit argb value.

---

Member Function Documentation

forcedinline uint32 PixelARGB::getARGB

(

)

const throw ()

forcedinline uint32 PixelARGB::getRB

(

)

const throw ()

forcedinline uint32 PixelARGB::getAG

(

)

const throw ()

forcedinline uint8 PixelARGB::getAlpha

(

)

const throw ()

forcedinline uint8 PixelARGB::getRed

(

)

const throw ()

forcedinline uint8 PixelARGB::getGreen

(

)

const throw ()

forcedinline uint8 PixelARGB::getBlue

(

)

const throw ()

forcedinline void PixelARGB::blend

(

const PixelARGB &

src

)

throw ()

Blends another pixel onto this one.

This takes into account the opacity of the pixel being overlaid, and blends it accordingly.

forcedinline void PixelARGB::blend

(

const PixelAlpha &

src

)

throw ()

Blends another pixel onto this one.

This takes into account the opacity of the pixel being overlaid, and blends it accordingly.

forcedinline void PixelARGB::blend

(

const PixelRGB &

src

)

throw ()

Blends another pixel onto this one.

This takes into account the opacity of the pixel being overlaid, and blends it accordingly.

template<class Pixel >

forcedinline void PixelARGB::blend	(	const Pixel &	src,
		uint32	extraAlpha
	)			throw ()

Blends another pixel onto this one, applying an extra multiplier to its opacity.

The opacity of the pixel being overlaid is scaled by the extraAlpha factor before being used, so this can blend semi-transparently from a PixelRGB argument.

template<class Pixel >

forcedinline void PixelARGB::tween	(	const Pixel &	src,
		const uint32	amount
	)			throw ()

Blends another pixel with this one, creating a colour that is somewhere between the two, as specified by the amount.

template<class Pixel >

forcedinline void PixelARGB::set

(

const Pixel &

src

)

throw ()

Copies another pixel colour over this one.

This doesn't blend it - this colour is simply replaced by the other one.

forcedinline void PixelARGB::setAlpha

(

const uint8

newAlpha

)

throw ()

Replaces the colour's alpha value with another one.

forcedinline void PixelARGB::multiplyAlpha

(

int

multiplier

)

throw ()

Multiplies the colour's alpha value with another one.

forcedinline void PixelARGB::multiplyAlpha

(

const float

multiplier

)

throw ()

void PixelARGB::setARGB	(	const uint8	a,
		const uint8	r,
		const uint8	g,
		const uint8	b
	)			throw ()

Sets the pixel's colour from individual components.

forcedinline void PixelARGB::premultiply

(

)

throw ()

Premultiplies the pixel's RGB values by its alpha.

forcedinline void PixelARGB::unpremultiply

(

)

throw ()

Unpremultiplies the pixel's RGB values.

References jmin().

forcedinline void PixelARGB::desaturate

(

)

throw ()

---

Member Data Documentation

uint32 PixelARGB::argb

uint8 PixelARGB::b

uint8 PixelARGB::g

uint8 PixelARGB::r

uint8 PixelARGB::a

struct { ... } PixelARGB::components

---

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

• juce_PixelFormats.h