Represents a 24-bit RGB pixel, and can perform compositing operations on it. More...

#include <juce_PixelFormats.h>

Collaboration diagram for juce::PixelRGB:

Public Types
enum	{ 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
	PixelRGB ()=default
	Creates a pixel without defining its colour. More...

	~PixelRGB ()=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

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	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 which is compatible with the native format of a PixelARGB. 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

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

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

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) noexcept
	This method is included for compatibility with the PixelARGB class. More...

void	setARGB (const uint8, const uint8 red, const uint8 green, const uint8 blue) 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
	PixelRGB (const uint32 internal) noexcept

Private Attributes
uint8	b

uint8	g

uint8	r

Detailed Description

Represents a 24-bit RGB pixel, and can perform compositing operations on it.

This is used internally by the imaging classes.

See also: PixelARGB

{Graphics}

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Enumerator
indexR
indexG
indexB

Constructor & Destructor Documentation

◆ PixelRGB() [1/2]

juce::PixelRGB::PixelRGB ( )

default

Creates a pixel without defining its colour.

◆ ~PixelRGB()

juce::PixelRGB::~PixelRGB ( )

default

◆ PixelRGB() [2/2]

juce::PixelRGB::PixelRGB ( const uint32 internal )

inlineprivatenoexcept

Member Function Documentation

◆ blend() [1/3]

template<class Pixel >

forcedinline void juce::PixelRGB::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(), and juce::maskPixelComponents().

◆ blend() [2/3]

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

inlinenoexcept

◆ blend() [3/3]

template<class Pixel >

forcedinline void juce::PixelRGB::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(), and juce::maskPixelComponents().

◆ desaturate()

forcedinline void juce::PixelRGB::desaturate ( )

inlinenoexcept

◆ getAlpha()

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

inlinenoexcept

◆ getBlue() [1/2]

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

inlinenoexcept

◆ getBlue() [2/2]

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

inlinenoexcept

◆ getEvenBytes()

forcedinline uint32 juce::PixelRGB::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 but compatible with the return value of getEvenBytes of the PixelARGB class.

See also: PixelARGB::getEvenBytes

Referenced by juce::PixelARGB::blend(), and juce::PixelARGB::tween().

◆ getGreen() [1/2]

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

inlinenoexcept

◆ getGreen() [2/2]

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

inlinenoexcept

◆ getInARGBMaskOrder()

forcedinline uint32 juce::PixelRGB::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::PixelRGB::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::PixelRGB::getNativeARGB ( ) const

inlinenoexcept

Returns a uint32 which represents the pixel in a platform dependent format which is compatible with the native format of a PixelARGB.

See also: PixelARGB::getNativeARGB

◆ getOddBytes()

forcedinline uint32 juce::PixelRGB::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 but compatible with the return value of getOddBytes of the PixelARGB class.

See also: PixelARGB::getOddBytes

Referenced by juce::PixelARGB::blend(), and juce::PixelARGB::tween().

◆ getRed() [1/2]

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

inlinenoexcept

◆ getRed() [2/2]

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

inlinenoexcept

◆ multiplyAlpha() [1/2]

forcedinline void juce::PixelRGB::multiplyAlpha ( int )

inlinenoexcept

Multiplies the colour's alpha value with another one.

◆ multiplyAlpha() [2/2]

forcedinline void juce::PixelRGB::multiplyAlpha ( float )

inlinenoexcept

Multiplies the colour's alpha value with another one.

◆ premultiply()

forcedinline void juce::PixelRGB::premultiply ( )

inlinenoexcept

Premultiplies the pixel's RGB values by its alpha.

◆ set()

template<class Pixel >

forcedinline void juce::PixelRGB::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. Because PixelRGB has no alpha channel, any alpha value in the source pixel is thrown away.

Referenced by juce::RenderingHelpers::EdgeTableFillers::SolidColour< PixelType, replaceExisting >::replaceLine().

◆ setAlpha()

forcedinline void juce::PixelRGB::setAlpha ( const uint8 )

inlinenoexcept

This method is included for compatibility with the PixelARGB class.

◆ setARGB()

void juce::PixelRGB::setARGB	(	const uint8	,
		const uint8	red,
		const uint8	green,
		const uint8	blue
	)

inlinenoexcept

Sets the pixel's colour from individual components.

◆ tween()

template<class Pixel >

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

◆ unpremultiply()

forcedinline void juce::PixelRGB::unpremultiply ( )

inlinenoexcept

Unpremultiplies the pixel's RGB values.

Member Data Documentation

◆ b

uint8 juce::PixelRGB::b

private

◆ g

uint8 juce::PixelRGB::g

private

◆ r

uint8 juce::PixelRGB::r

private

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

juce_PixelFormats.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PixelRGB() [1/2]

◆ ~PixelRGB()

◆ PixelRGB() [2/2]

Member Function Documentation

◆ blend() [1/3]

◆ blend() [2/3]

◆ blend() [3/3]

◆ desaturate()

◆ getAlpha()

◆ getBlue() [1/2]

◆ getBlue() [2/2]

◆ getEvenBytes()

◆ getGreen() [1/2]

◆ getGreen() [2/2]

◆ getInARGBMaskOrder()

◆ getInARGBMemoryOrder()

◆ getNativeARGB()

◆ getOddBytes()

◆ getRed() [1/2]

◆ getRed() [2/2]

◆ multiplyAlpha() [1/2]

◆ multiplyAlpha() [2/2]

◆ premultiply()

◆ set()

◆ setAlpha()

◆ setARGB()

◆ tween()

◆ unpremultiply()

Member Data Documentation

◆ b

◆ g

◆ r