openshot-audio  0.1.7
Public Types | Public Member Functions | List of all members
PixelAlpha Class Reference

#include <juce_PixelFormats.h>

Public Types

enum  { indexA = 0 }
 

Public Member Functions

 PixelAlpha () noexcept
 
 ~PixelAlpha () noexcept
 
forcedinline uint32 getNativeARGB () const noexcept
 
forcedinline uint32 getInARGBMaskOrder () const noexcept
 
uint32 getInARGBMemoryOrder () const noexcept
 
forcedinline uint32 getEvenBytes () const noexcept
 
forcedinline uint32 getOddBytes () const noexcept
 
forcedinline uint8 getAlpha () const noexcept
 
forcedinline uint8getAlpha () 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
 
forcedinline void setARGB (const uint8 a_, const uint8, const uint8, const uint8) noexcept
 
template<class Pixel >
forcedinline void blend (const Pixel &src) noexcept
 
template<class Pixel >
forcedinline void blend (const Pixel &src, uint32 extraAlpha) noexcept
 
template<class Pixel >
forcedinline void tween (const Pixel &src, const uint32 amount) noexcept
 
forcedinline void setAlpha (const uint8 newAlpha) noexcept
 
forcedinline void multiplyAlpha (int multiplier) noexcept
 
forcedinline void multiplyAlpha (const float multiplier) noexcept
 
forcedinline void premultiply () noexcept
 
forcedinline void unpremultiply () noexcept
 
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

Member Enumeration Documentation

anonymous enum

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

Enumerator
indexA 

Constructor & Destructor Documentation

PixelAlpha::PixelAlpha ( )
inlinenoexcept

Creates a pixel without defining its colour.

PixelAlpha::~PixelAlpha ( )
inlinenoexcept

Member Function Documentation

template<class Pixel >
forcedinline void PixelAlpha::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.

template<class Pixel >
forcedinline void PixelAlpha::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.

forcedinline void PixelAlpha::desaturate ( )
inlinenoexcept
forcedinline uint8 PixelAlpha::getAlpha ( ) const
inlinenoexcept
forcedinline uint8& PixelAlpha::getAlpha ( )
inlinenoexcept
forcedinline uint8 PixelAlpha::getBlue ( ) const
inlinenoexcept
forcedinline uint32 PixelAlpha::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
forcedinline uint8 PixelAlpha::getGreen ( ) const
inlinenoexcept
forcedinline uint32 PixelAlpha::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).

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

forcedinline uint32 PixelAlpha::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
forcedinline uint32 PixelAlpha::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
forcedinline uint8 PixelAlpha::getRed ( ) const
inlinenoexcept
forcedinline void PixelAlpha::multiplyAlpha ( int  multiplier)
inlinenoexcept

Multiplies the colour's alpha value with another one.

forcedinline void PixelAlpha::multiplyAlpha ( const float  multiplier)
inlinenoexcept
forcedinline void PixelAlpha::premultiply ( )
inlinenoexcept

Premultiplies the pixel's RGB values by its alpha.

template<class Pixel >
forcedinline void PixelAlpha::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.

forcedinline void PixelAlpha::setAlpha ( const uint8  newAlpha)
inlinenoexcept

Replaces the colour's alpha value with another one.

forcedinline void PixelAlpha::setARGB ( const uint8  a_,
const uint8  ,
const uint8  ,
const uint8   
)
inlinenoexcept

Sets the pixel's colour from individual components.

template<class Pixel >
forcedinline void PixelAlpha::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.

forcedinline void PixelAlpha::unpremultiply ( )
inlinenoexcept

Unpremultiplies the pixel's RGB values.


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