PixelARGB Class Reference
juce_graphics » colour

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

## 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 ()=default
| PixelARGB (const uint8 a, const uint8 r, const uint8 g, const uint8 b) noexcept
forcedinline uint32 | getNativeARGB () const noexcept
| Returns a uint32 which represents the pixel in a platform dependent format. More...
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 | getEvenBytes () const noexcept
| Return channels with an even index and insert zero bytes between them. More...
forcedinline uint32 | getOddBytes () const noexcept
| Return channels with an odd index and insert zero bytes between them. More...
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. 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 | 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...
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 | setAlpha (const uint8 newAlpha) noexcept
| Replaces the colour's alpha value with another one. More...
forcedinline void | multiplyAlpha (int multiplier) noexcept
| Multiplies the colour's alpha value with another one. More...
forcedinline void | multiplyAlpha (const float multiplier) noexcept
PixelARGB | getUnpremultiplied () const noexcept
forcedinline void | premultiply () noexcept
| Premultiplies the pixel's RGB values by its alpha. More...
forcedinline void | unpremultiply () noexcept
| Unpremultiplies the pixel's RGB values. More...
forcedinline void | desaturate () noexcept

## 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/2]

PixelARGB::PixelARGB | ( |  | ) |

default

Creates a pixel without defining its colour.

## ~PixelARGB()

PixelARGB::~PixelARGB | ( |  | ) |

default

## PixelARGB() [2/2]

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

noexcept

## Member Function Documentation

## getNativeARGB()

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

noexcept

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

## getInARGBMaskOrder()

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

## getInARGBMemoryOrder()

uint32 PixelARGB::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

## getEvenBytes()

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

## getOddBytes()

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

## getAlpha()

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

noexcept

Referenced by Colour::getAlpha().

## getRed()

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

noexcept

Referenced by Colour::getRed().

## getGreen()

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

noexcept

Referenced by Colour::getGreen().

## getBlue()

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

noexcept

Referenced by Colour::getBlue().

## set()

template<class Pixel >

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

## setARGB()

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

noexcept

Sets the pixel's colour from individual components.

## blend() [1/2]

template<class Pixel >

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

References clampPixelComponents(), and maskPixelComponents().

## blend() [2/2]

template<class Pixel >

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

References clampPixelComponents(), and maskPixelComponents().

## tween()

template<class Pixel >

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

## setAlpha()

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

noexcept

Replaces the colour's alpha value with another one.

## multiplyAlpha() [1/2]

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

noexcept

Multiplies the colour's alpha value with another one.

## multiplyAlpha() [2/2]

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

noexcept

## getUnpremultiplied()

PixelARGB PixelARGB::getUnpremultiplied | ( |  | ) | const

noexcept

References unpremultiply().

## premultiply()

forcedinline void PixelARGB::premultiply | ( |  | ) |

noexcept

Premultiplies the pixel's RGB values by its alpha.

## unpremultiply()

forcedinline void PixelARGB::unpremultiply | ( |  | ) |

noexcept

Unpremultiplies the pixel's RGB values.

References jmin().

Referenced by getUnpremultiplied().

## desaturate()

forcedinline void PixelARGB::desaturate | ( |  | ) |

noexcept

References int().

## Member Data Documentation

## internal

uint32 PixelARGB::internal

## components

Components PixelARGB::components

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

- juce_PixelFormats.h