JUCE  v5.1.1-3-g1a0b28c73
JUCE API
PixelARGB Class Reference

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

#include <juce_PixelFormats.h>

Collaboration diagram for 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 () noexcept
 Creates a pixel without defining its colour. More...
 
 PixelARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) noexcept
 
 ~PixelARGB () noexcept
 
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 uint8getAlpha () noexcept
 
forcedinline uint8 getBlue () const noexcept
 
forcedinline uint8getBlue () 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 uint8getGreen () 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 uint8getRed () 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 (const uint32 internalValue) noexcept
 

Private Attributes

union {
   Components   components
 
   uint8   comps [4]
 
   uint32   internal
 
}; 
 
struct 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

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]

PixelARGB::PixelARGB ( )
inlinenoexcept

Creates a pixel without defining its colour.

◆ ~PixelARGB()

PixelARGB::~PixelARGB ( )
inlinenoexcept

◆ PixelARGB() [2/3]

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

◆ PixelARGB() [3/3]

PixelARGB::PixelARGB ( const uint32  internalValue)
inlineprivatenoexcept

Member Function Documentation

◆ blend() [1/3]

template<class Pixel >
forcedinline void 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 clampPixelComponents(), forcedinline, and maskPixelComponents().

◆ blend() [2/3]

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

◆ desaturate()

forcedinline void PixelARGB::desaturate ( )
inlinenoexcept

◆ getAlpha() [1/2]

◆ getAlpha() [2/2]

forcedinline uint8& PixelARGB::getAlpha ( )
inlinenoexcept

◆ getBlue() [1/2]

forcedinline uint8 PixelARGB::getBlue ( ) const
inlinenoexcept

Referenced by Colour::getBlue().

◆ getBlue() [2/2]

forcedinline uint8& PixelARGB::getBlue ( )
inlinenoexcept

References forcedinline.

◆ getEvenBytes()

forcedinline uint32 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 PixelARGB::getGreen ( ) const
inlinenoexcept

Referenced by Colour::getGreen().

◆ getGreen() [2/2]

forcedinline uint8& PixelARGB::getGreen ( )
inlinenoexcept

◆ getInARGBMaskOrder()

forcedinline uint32 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 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 PixelARGB::getNativeARGB ( ) const
inlinenoexcept

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

◆ getOddBytes()

forcedinline uint32 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 PixelARGB::getRed ( ) const
inlinenoexcept

Referenced by Colour::getRed().

◆ getRed() [2/2]

forcedinline uint8& PixelARGB::getRed ( )
inlinenoexcept

◆ getUnpremultiplied()

PixelARGB PixelARGB::getUnpremultiplied ( ) const
inlinenoexcept

References unpremultiply().

◆ multiplyAlpha() [1/2]

forcedinline void PixelARGB::multiplyAlpha ( int  multiplier)
inlinenoexcept

Multiplies the colour's alpha value with another one.

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

◆ multiplyAlpha() [2/2]

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

◆ premultiply()

forcedinline void PixelARGB::premultiply ( )
inlinenoexcept

Premultiplies the pixel's RGB values by its alpha.

◆ set()

template<class Pixel >
forcedinline void 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 PixelARGB::setAlpha ( const uint8  newAlpha)
inlinenoexcept

Replaces the colour's alpha value with another one.

◆ setARGB()

void 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 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 PixelRGB::getEvenBytes(), and PixelRGB::getOddBytes().

◆ unpremultiply()

forcedinline void PixelARGB::unpremultiply ( )
inlinenoexcept

Unpremultiplies the pixel's RGB values.

References juce::jmin().

Referenced by getUnpremultiplied().

Member Data Documentation

◆ @30

union { ... }

◆ components

Components PixelARGB::components

◆ comps

uint8 PixelARGB::comps[4]

◆ internal

uint32 PixelARGB::internal

◆ JUCE_PACKED

struct PixelARGB::Components PixelARGB::JUCE_PACKED
private

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