PixelAlpha Class Reference

Represents an 8-bit single-channel pixel, and can perform compositing operations on it. More...

List of all members.

Public Types
enum	{ indexA = 0 }
	The indexes of the different components in the byte layout of this type of colour. More...
Public Member Functions
	PixelAlpha () noexcept
	Creates a pixel without defining its colour.
	~PixelAlpha () noexcept
	PixelAlpha (const uint32 argb) noexcept
	Creates a pixel from a 32-bit argb value.
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.
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
forcedinline void	setARGB (const uint8 a_, const uint8, const uint8, const uint8) 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

---

Detailed Description

Represents an 8-bit single-channel pixel, and can perform compositing operations on it.

This is used internally by the imaging classes.

See also:

PixelARGB, PixelRGB

---

Member Enumeration Documentation

anonymous enum

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

Enumerator:

indexA

---

Constructor & Destructor Documentation

PixelAlpha::PixelAlpha

(

)

Creates a pixel without defining its colour.

PixelAlpha::~PixelAlpha

(

)

PixelAlpha::PixelAlpha

(

const uint32

argb

)

Creates a pixel from a 32-bit argb value.

(The argb format is that used by PixelARGB)

---

Member Function Documentation

forcedinline uint32 PixelAlpha::getARGB

(

)

const

forcedinline uint32 PixelAlpha::getUnpremultipliedARGB

(

)

const

forcedinline uint32 PixelAlpha::getRB

(

)

const

forcedinline uint32 PixelAlpha::getAG

(

)

const

forcedinline uint8 PixelAlpha::getAlpha

(

)

const

forcedinline uint8 PixelAlpha::getRed

(

)

const

forcedinline uint8 PixelAlpha::getGreen

(

)

const

forcedinline uint8 PixelAlpha::getBlue

(

)

const

template<class Pixel >

forcedinline void PixelAlpha::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.

template<class Pixel >

forcedinline void PixelAlpha::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 PixelAlpha::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 PixelAlpha::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 PixelAlpha::setAlpha

(

const uint8

newAlpha

)

Replaces the colour's alpha value with another one.

forcedinline void PixelAlpha::multiplyAlpha

(

int

multiplier

)

Multiplies the colour's alpha value with another one.

forcedinline void PixelAlpha::multiplyAlpha

(

const float

multiplier

)

forcedinline void PixelAlpha::setARGB	(	const uint8	a_,
		const uint8	,
		const uint8	,
		const uint8
	)

Sets the pixel's colour from individual components.

forcedinline void PixelAlpha::premultiply

(

)

Premultiplies the pixel's RGB values by its alpha.

forcedinline void PixelAlpha::unpremultiply

(

)

Unpremultiplies the pixel's RGB values.

forcedinline void PixelAlpha::desaturate

(

)

---

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

• juce_PixelFormats.h