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

#include "juce_PixelFormats.h"

Public Types
enum	{ indexA }
	The indexes of the different components in the byte layout of this type of colour. More...

Public Member Functions
	PixelAlpha () noexcept=default
	Creates a pixel without defining its colour.

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.

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

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

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

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

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	set (const Pixel &src) noexcept
	Copies another pixel colour over this one.

forcedinline void	setARGB (uint8 a_, uint8, uint8, uint8) noexcept
	Sets the pixel's colour from individual components.

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, uint32 amount) noexcept
	Blends another pixel with this one, creating a colour that is somewhere between the two, as specified by the amount.

forcedinline void	setAlpha (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 (float multiplier) noexcept

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

@tags{Graphics}

Definition at line 599 of file juce_PixelFormats.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Definition at line 721 of file juce_PixelFormats.h.

Member Function Documentation

◆ blend() [1/2]

template<class Pixel >

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

noexcept

Blends another pixel onto this one.

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

Definition at line 664 of file juce_PixelFormats.h.

◆ blend() [2/2]

template<class Pixel >

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

noexcept

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.

Definition at line 676 of file juce_PixelFormats.h.

◆ desaturate()

forcedinline void juce::PixelAlpha::desaturate ( )

noexcept

Definition at line 717 of file juce_PixelFormats.h.

◆ getAlpha()

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

noexcept

Definition at line 635 of file juce_PixelFormats.h.

◆ getBlue()

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

noexcept

Definition at line 638 of file juce_PixelFormats.h.

◆ getEvenBytes()

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

noexcept

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

Definition at line 625 of file juce_PixelFormats.h.

◆ getGreen()

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

noexcept

Definition at line 637 of file juce_PixelFormats.h.

◆ getInARGBMaskOrder()

forcedinline uint32 juce::PixelAlpha::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).

Definition at line 614 of file juce_PixelFormats.h.

◆ getInARGBMemoryOrder()

uint32 juce::PixelAlpha::getInARGBMemoryOrder ( ) const

noexcept

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

Definition at line 618 of file juce_PixelFormats.h.

◆ getNativeARGB()

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

See also: PixelARGB::getNativeARGB

Definition at line 610 of file juce_PixelFormats.h.

◆ getOddBytes()

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

noexcept

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

Definition at line 632 of file juce_PixelFormats.h.

◆ getRed()

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

noexcept

Definition at line 636 of file juce_PixelFormats.h.

◆ multiplyAlpha() [1/2]

forcedinline void juce::PixelAlpha::multiplyAlpha ( float multiplier )

noexcept

Definition at line 706 of file juce_PixelFormats.h.

◆ multiplyAlpha() [2/2]

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

noexcept

Multiplies the colour's alpha value with another one.

Definition at line 700 of file juce_PixelFormats.h.

◆ premultiply()

forcedinline void juce::PixelAlpha::premultiply ( )

noexcept

Premultiplies the pixel's RGB values by its alpha.

Definition at line 712 of file juce_PixelFormats.h.

◆ set()

template<class Pixel >

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

noexcept

Copies another pixel colour over this one.

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

Definition at line 646 of file juce_PixelFormats.h.

◆ setAlpha()

forcedinline void juce::PixelAlpha::setAlpha ( uint8 newAlpha )

noexcept

Replaces the colour's alpha value with another one.

Definition at line 694 of file juce_PixelFormats.h.

◆ setARGB()

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

noexcept

Sets the pixel's colour from individual components.

Definition at line 652 of file juce_PixelFormats.h.

◆ tween()

template<class Pixel >

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

noexcept

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

Definition at line 687 of file juce_PixelFormats.h.

◆ unpremultiply()

forcedinline void juce::PixelAlpha::unpremultiply ( )

noexcept

Unpremultiplies the pixel's RGB values.

Definition at line 715 of file juce_PixelFormats.h.

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

juce_graphics/colour/juce_PixelFormats.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ blend() [1/2]

◆ blend() [2/2]

◆ desaturate()

◆ getAlpha()

◆ getBlue()

◆ getEvenBytes()

◆ getGreen()

◆ getInARGBMaskOrder()

◆ getInARGBMemoryOrder()

◆ getNativeARGB()

◆ getOddBytes()

◆ getRed()

◆ multiplyAlpha() [1/2]

◆ multiplyAlpha() [2/2]

◆ premultiply()

◆ set()

◆ setAlpha()

◆ setARGB()

◆ tween()

◆ unpremultiply()