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

#include <juce_PixelFormats.h>

Collaboration diagram for juce::PixelARGB:

Classes
struct	Components

Public Types
enum	{ indexA = 3, indexR = 0, indexG = 1, indexB = 2 }
	The indexes of the different components in the byte layout of this type of colour. More...

Public Member Functions
	PixelARGB ()=default
	Creates a pixel without defining its colour. More...

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

	~PixelARGB ()=default

template<class Pixel >
forcedinline void	blend (const Pixel &src) noexcept
	Blends another pixel onto this one. More...

forcedinline void	blend (const PixelRGB src) noexcept
	Blends another pixel onto this one. More...

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. More...

forcedinline void	desaturate () noexcept

forcedinline uint8	getAlpha () const noexcept

forcedinline uint8 &	getAlpha () noexcept

forcedinline uint8	getBlue () const noexcept

forcedinline uint8 &	getBlue () noexcept

forcedinline uint32	getEvenBytes () const noexcept
	Return channels with an even index and insert zero bytes between them. More...

forcedinline uint8	getGreen () const noexcept

forcedinline uint8 &	getGreen () noexcept

forcedinline uint32	getInARGBMaskOrder () const noexcept
	Returns a uint32 which will be in argb order as if constructed with the following mask operation ((alpha << 24) \| (red << 16) \| (green << 8) \| blue). More...

uint32	getInARGBMemoryOrder () const noexcept
	Returns a uint32 which when written to memory, will be in the order a, r, g, b. More...

forcedinline uint32	getNativeARGB () const noexcept
	Returns a uint32 which represents the pixel in a platform dependent format. More...

forcedinline uint32	getOddBytes () const noexcept
	Return channels with an odd index and insert zero bytes between them. More...

forcedinline uint8	getRed () const noexcept

forcedinline uint8 &	getRed () noexcept

PixelARGB	getUnpremultiplied () const noexcept

forcedinline void	multiplyAlpha (int multiplier) noexcept
	Multiplies the colour's alpha value with another one. More...

forcedinline void	multiplyAlpha (const float multiplier) noexcept

forcedinline void	premultiply () noexcept
	Premultiplies the pixel's RGB values by its alpha. More...

template<class Pixel >
forcedinline void	set (const Pixel &src) noexcept
	Copies another pixel colour over this one. More...

forcedinline void	setAlpha (const uint8 newAlpha) noexcept
	Replaces the colour's alpha value with another one. More...

void	setARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) noexcept
	Sets the pixel's colour from individual components. More...

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. More...

forcedinline void	unpremultiply () noexcept
	Unpremultiplies the pixel's RGB values. More...

Private Member Functions
	PixelARGB (uint32 internalValue) noexcept

Private Attributes
union {
Components components

uint8 comps [4]

uint32 internal

};

struct juce::PixelARGB::Components	JUCE_PACKED

Detailed Description

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

This is used internally by the imaging classes.

See also: PixelRGB

{Graphics}

Member Enumeration Documentation

◆ anonymous enum

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() [1/3]

juce::PixelARGB::PixelARGB ( )

default

Creates a pixel without defining its colour.

◆ ~PixelARGB()

juce::PixelARGB::~PixelARGB ( )

default

◆ PixelARGB() [2/3]

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

inlinenoexcept

◆ PixelARGB() [3/3]

juce::PixelARGB::PixelARGB ( uint32 internalValue )

inlineprivatenoexcept

Member Function Documentation

◆ blend() [1/3]

template<class Pixel >

forcedinline void juce::PixelARGB::blend ( const Pixel & src )

inlinenoexcept

Blends another pixel onto this one.

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

References juce::clampPixelComponents(), forcedinline, and juce::maskPixelComponents().

◆ blend() [2/3]

forcedinline void juce::PixelARGB::blend ( const PixelRGB src )

noexcept

Blends another pixel onto this one.

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

◆ blend() [3/3]

template<class Pixel >

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

inlinenoexcept

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.

References juce::clampPixelComponents(), juce::PixelRGB::getEvenBytes(), juce::PixelRGB::getOddBytes(), and juce::maskPixelComponents().

◆ desaturate()

forcedinline void juce::PixelARGB::desaturate ( )

inlinenoexcept

References int().

◆ getAlpha() [1/2]

forcedinline uint8 juce::PixelARGB::getAlpha ( ) const

inlinenoexcept

Referenced by juce::Colour::getAlpha().

◆ getAlpha() [2/2]

forcedinline uint8& juce::PixelARGB::getAlpha ( )

inlinenoexcept

◆ getBlue() [1/2]

forcedinline uint8 juce::PixelARGB::getBlue ( ) const

inlinenoexcept

Referenced by juce::Colour::getBlue().

◆ getBlue() [2/2]

forcedinline uint8& juce::PixelARGB::getBlue ( )

inlinenoexcept

References forcedinline.

◆ getEvenBytes()

forcedinline uint32 juce::PixelARGB::getEvenBytes ( ) const

inlinenoexcept

Return channels with an even index and insert zero bytes between them.

This is useful for blending operations. The exact channels which are returned is platform dependent.

◆ getGreen() [1/2]

forcedinline uint8 juce::PixelARGB::getGreen ( ) const

inlinenoexcept

Referenced by juce::Colour::getGreen().

◆ getGreen() [2/2]

forcedinline uint8& juce::PixelARGB::getGreen ( )

inlinenoexcept

◆ getInARGBMaskOrder()

forcedinline uint32 juce::PixelARGB::getInARGBMaskOrder ( ) const

inlinenoexcept

Returns a uint32 which will be in argb order as if constructed with the following mask operation ((alpha << 24) | (red << 16) | (green << 8) | blue).

◆ getInARGBMemoryOrder()

uint32 juce::PixelARGB::getInARGBMemoryOrder ( ) const

inlinenoexcept

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

In other words, if the return-value is read as a uint8 array then the elements will be in the order of a, r, g, b

◆ getNativeARGB()

forcedinline uint32 juce::PixelARGB::getNativeARGB ( ) const

inlinenoexcept

Returns a uint32 which represents the pixel in a platform dependent format.

◆ getOddBytes()

forcedinline uint32 juce::PixelARGB::getOddBytes ( ) const

inlinenoexcept

Return channels with an odd index and insert zero bytes between them.

This is useful for blending operations. The exact channels which are returned is platform dependent.

◆ getRed() [1/2]

forcedinline uint8 juce::PixelARGB::getRed ( ) const

inlinenoexcept

Referenced by juce::Colour::getRed().

◆ getRed() [2/2]

forcedinline uint8& juce::PixelARGB::getRed ( )

inlinenoexcept

◆ getUnpremultiplied()

PixelARGB juce::PixelARGB::getUnpremultiplied ( ) const

inlinenoexcept

References unpremultiply().

◆ multiplyAlpha() [1/2]

forcedinline void juce::PixelARGB::multiplyAlpha ( int multiplier )

inlinenoexcept

Multiplies the colour's alpha value with another one.

◆ multiplyAlpha() [2/2]

forcedinline void juce::PixelARGB::multiplyAlpha ( const float multiplier )

inlinenoexcept

◆ premultiply()

forcedinline void juce::PixelARGB::premultiply ( )

inlinenoexcept

Premultiplies the pixel's RGB values by its alpha.

◆ set()

template<class Pixel >

forcedinline void juce::PixelARGB::set ( const Pixel & src )

inlinenoexcept

Copies another pixel colour over this one.

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

◆ setAlpha()

forcedinline void juce::PixelARGB::setAlpha ( const uint8 newAlpha )

inlinenoexcept

Replaces the colour's alpha value with another one.

◆ setARGB()

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

inlinenoexcept

Sets the pixel's colour from individual components.

◆ tween()

template<class Pixel >

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

inlinenoexcept

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

References juce::PixelRGB::getEvenBytes(), and juce::PixelRGB::getOddBytes().

◆ unpremultiply()

forcedinline void juce::PixelARGB::unpremultiply ( )

inlinenoexcept

Unpremultiplies the pixel's RGB values.

References juce::jmin().

Referenced by getUnpremultiplied().

Member Data Documentation

◆ @20

union { ... }

◆ components

Components juce::PixelARGB::components

◆ comps

uint8 juce::PixelARGB::comps[4]

◆ internal

uint32 juce::PixelARGB::internal

◆ JUCE_PACKED

struct juce::PixelARGB::Components juce::PixelARGB::JUCE_PACKED

private

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

juce_PixelFormats.h

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PixelARGB() [1/3]

◆ ~PixelARGB()

◆ PixelARGB() [2/3]

◆ PixelARGB() [3/3]

Member Function Documentation

◆ blend() [1/3]

◆ blend() [2/3]

◆ blend() [3/3]

◆ desaturate()

◆ getAlpha() [1/2]

◆ getAlpha() [2/2]

◆ getBlue() [1/2]

◆ getBlue() [2/2]

◆ getEvenBytes()

◆ getGreen() [1/2]

◆ getGreen() [2/2]

◆ getInARGBMaskOrder()

◆ getInARGBMemoryOrder()

◆ getNativeARGB()

◆ getOddBytes()

◆ getRed() [1/2]

◆ getRed() [2/2]

◆ getUnpremultiplied()

◆ multiplyAlpha() [1/2]

◆ multiplyAlpha() [2/2]

◆ premultiply()

◆ set()

◆ setAlpha()

◆ setARGB()

◆ tween()

◆ unpremultiply()

Member Data Documentation

◆ @20

◆ components

◆ comps

◆ internal

◆ JUCE_PACKED