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 () noexcept
	Creates a pixel without defining its colour.
	~PixelARGB () noexcept
	PixelARGB (const uint32 argb_) noexcept
	Creates a pixel from a 32-bit argb value.
	PixelARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) noexcept
forcedinline uint32	getARGB () const noexcept
forcedinline uint32	getUnpremultipliedARGB () const noexcept
forcedinline uint32	getRB () const noexcept
forcedinline uint32	getAG () const noexcept
forcedinline uint8	getAlpha () const noexcept
forcedinline uint8	getRed () const noexcept
forcedinline uint8	getGreen () const noexcept
forcedinline uint8	getBlue () const noexcept
template<class Pixel >
forcedinline void	blend (const Pixel &src) noexcept
	Blends another pixel onto this one.
forcedinline void	blend (const PixelRGB &src) noexcept
	Blends another pixel onto this one.
template<class Pixel >
forcedinline void	blend (const Pixel &src, uint32 extraAlpha) noexcept
	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) noexcept
	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) noexcept
	Copies another pixel colour over this one.
forcedinline void	setAlpha (const uint8 newAlpha) noexcept
	Replaces the colour's alpha value with another one.
forcedinline void	multiplyAlpha (int multiplier) noexcept
	Multiplies the colour's alpha value with another one.
forcedinline void	multiplyAlpha (const float multiplier) noexcept
void	setARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) noexcept
	Sets the pixel's colour from individual components.
forcedinline void	premultiply () noexcept
	Premultiplies the pixel's RGB values by its alpha.
forcedinline void	unpremultiply () noexcept
	Unpremultiplies the pixel's RGB values.
forcedinline void	desaturate () noexcept
uint32	getInRGBAMemoryOrder () const noexcept
	Returns a uint32 which when written to memory, will be in the order r, g, b, a.

---

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

(

)

Creates a pixel without defining its colour.

PixelARGB::~PixelARGB

(

)

PixelARGB::PixelARGB

(

const uint32

argb_

)

Creates a pixel from a 32-bit argb value.

PixelARGB::PixelARGB	(	const uint8	a,
		const uint8	r,
		const uint8	g,
		const uint8	b
	)

---

Member Function Documentation

forcedinline uint32 PixelARGB::getARGB

(

)

const

Referenced by getUnpremultipliedARGB().

forcedinline uint32 PixelARGB::getUnpremultipliedARGB

(

)

const

References getARGB(), and unpremultiply().

forcedinline uint32 PixelARGB::getRB

(

)

const

forcedinline uint32 PixelARGB::getAG

(

)

const

forcedinline uint8 PixelARGB::getAlpha

(

)

const

Referenced by Colour::getAlpha().

forcedinline uint8 PixelARGB::getRed

(

)

const

forcedinline uint8 PixelARGB::getGreen

(

)

const

forcedinline uint8 PixelARGB::getBlue

(

)

const

template<class Pixel >

forcedinline void PixelARGB::blend

(

const Pixel &

src

)

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

)

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
	)

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
	)

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

)

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

)

Replaces the colour's alpha value with another one.

forcedinline void PixelARGB::multiplyAlpha

(

int

multiplier

)

Multiplies the colour's alpha value with another one.

forcedinline void PixelARGB::multiplyAlpha

(

const float

multiplier

)

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

Sets the pixel's colour from individual components.

forcedinline void PixelARGB::premultiply

(

)

Premultiplies the pixel's RGB values by its alpha.

forcedinline void PixelARGB::unpremultiply

(

)

Unpremultiplies the pixel's RGB values.

References jmin().

Referenced by getUnpremultipliedARGB().

forcedinline void PixelARGB::desaturate

(

)

uint32 PixelARGB::getInRGBAMemoryOrder

(

)

const

Returns a uint32 which when written to memory, will be in the order r, g, b, a.

---

Member Data Documentation

uint32 PixelARGB::argb

Components PixelARGB::components

---

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

• juce_PixelFormats.h