Lumitronix_Iflex_Pro_Workshop
Library to interact with the iFlexPro
RgbColor Struct Reference

#include <RgbColor.h>

Inheritance diagram for RgbColor:
RgbColorBase

Public Types

typedef NeoRgbCurrentSettings SettingsObject
 

Public Member Functions

 RgbColor (uint8_t r, uint8_t g, uint8_t b)
 
 RgbColor (uint8_t brightness)
 
 RgbColor (const RgbwColor &color)
 
 RgbColor (const Rgb16Color &color)
 
 RgbColor (const HtmlColor &color)
 
 RgbColor (const HslColor &color)
 
 RgbColor (const HsbColor &color)
 
 RgbColor ()
 
bool operator== (const RgbColor &other) const
 
bool operator!= (const RgbColor &other) const
 
int16_t CompareTo (const RgbColor &other, uint8_t epsilon=1)
 
uint8_t operator[] (size_t idx) const
 
uint8_t & operator[] (size_t idx)
 
uint8_t CalculateBrightness () const
 
RgbColor Dim (uint8_t ratio) const
 
RgbColor Brighten (uint8_t ratio) const
 
void Darken (uint8_t delta)
 
void Lighten (uint8_t delta)
 
uint32_t CalcTotalTenthMilliAmpere (const SettingsObject &settings)
 

Static Public Member Functions

static int16_t Compare (const RgbColor &left, const RgbColor &right, uint8_t epsilon=1)
 
static RgbColor LinearBlend (const RgbColor &left, const RgbColor &right, float progress)
 
static RgbColor LinearBlend (const RgbColor &left, const RgbColor &right, uint8_t progress)
 
static RgbColor BilinearBlend (const RgbColor &c00, const RgbColor &c01, const RgbColor &c10, const RgbColor &c11, float x, float y)
 

Public Attributes

uint8_t R
 
uint8_t G
 
uint8_t B
 

Static Public Attributes

static const uint8_t Max = 255
 
static const size_t Count = 3
 

Additional Inherited Members

- Static Protected Member Functions inherited from RgbColorBase
static float _CalcColor (float p, float q, float t)
 
static void _HslToRgb (const HslColor &color, float *r, float *g, float *b)
 
static void _HsbToRgb (const HsbColor &color, float *r, float *g, float *b)
 
template<typename T_COLOR , typename T_RESULT >
static T_RESULT _Compare (const T_COLOR &left, const T_COLOR &right, T_RESULT epsilon)
 

Member Typedef Documentation

◆ SettingsObject

Constructor & Destructor Documentation

◆ RgbColor() [1/8]

RgbColor::RgbColor ( uint8_t  r,
uint8_t  g,
uint8_t  b 
)
inline

◆ RgbColor() [2/8]

RgbColor::RgbColor ( uint8_t  brightness)
inline

◆ RgbColor() [3/8]

RgbColor::RgbColor ( const RgbwColor color)
explicit

◆ RgbColor() [4/8]

RgbColor::RgbColor ( const Rgb16Color color)

◆ RgbColor() [5/8]

RgbColor::RgbColor ( const HtmlColor color)

◆ RgbColor() [6/8]

RgbColor::RgbColor ( const HslColor color)

◆ RgbColor() [7/8]

RgbColor::RgbColor ( const HsbColor color)

◆ RgbColor() [8/8]

RgbColor::RgbColor ( )
inline

Member Function Documentation

◆ BilinearBlend()

RgbColor RgbColor::BilinearBlend ( const RgbColor c00,
const RgbColor c01,
const RgbColor c10,
const RgbColor c11,
float  x,
float  y 
)
static

◆ Brighten()

RgbColor RgbColor::Brighten ( uint8_t  ratio) const

◆ CalcTotalTenthMilliAmpere()

uint32_t RgbColor::CalcTotalTenthMilliAmpere ( const SettingsObject settings)
inline

◆ CalculateBrightness()

uint8_t RgbColor::CalculateBrightness ( ) const

◆ Compare()

static int16_t RgbColor::Compare ( const RgbColor left,
const RgbColor right,
uint8_t  epsilon = 1 
)
inlinestatic

◆ CompareTo()

int16_t RgbColor::CompareTo ( const RgbColor other,
uint8_t  epsilon = 1 
)
inline

◆ Darken()

void RgbColor::Darken ( uint8_t  delta)

◆ Dim()

RgbColor RgbColor::Dim ( uint8_t  ratio) const

◆ Lighten()

void RgbColor::Lighten ( uint8_t  delta)

◆ LinearBlend() [1/2]

RgbColor RgbColor::LinearBlend ( const RgbColor left,
const RgbColor right,
float  progress 
)
static

◆ LinearBlend() [2/2]

RgbColor RgbColor::LinearBlend ( const RgbColor left,
const RgbColor right,
uint8_t  progress 
)
static

◆ operator!=()

bool RgbColor::operator!= ( const RgbColor other) const
inline

◆ operator==()

bool RgbColor::operator== ( const RgbColor other) const
inline

◆ operator[]() [1/2]

uint8_t& RgbColor::operator[] ( size_t  idx)
inline

◆ operator[]() [2/2]

uint8_t RgbColor::operator[] ( size_t  idx) const
inline

Member Data Documentation

◆ B

uint8_t RgbColor::B

◆ Count

const size_t RgbColor::Count = 3
static

◆ G

uint8_t RgbColor::G

◆ Max

const uint8_t RgbColor::Max = 255
static

◆ R

uint8_t RgbColor::R