VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
CColor Struct Reference

RGBA Color structure. More...

Public Member Functions

constexpr CColor ()=default
 
constexpr CColor (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha=255)
 
constexpr CColor (const CColor &inColor)
 
bool fromString (UTF8StringPtr str)
 
UTF8String toString () const
 
Operator Methods
CColoroperator() (uint8_t _red, uint8_t _green, uint8_t _blue, uint8_t _alpha)
 
CColoroperator= (const CColor &newColor)
 
bool operator!= (const CColor &other) const
 
bool operator== (const CColor &other) const
 
Convert Methods
void toHSV (double &hue, double &saturation, double &value) const
 convert to hue, saturation and value More...
 
void fromHSV (double hue, double saturation, double value)
 convert from hue, saturation and value More...
 
void toHSL (double &hue, double &saturation, double &lightness) const
 convert to hue, saturation and lightness More...
 
void fromHSL (double hue, double saturation, double lightness)
 convert from hue, saturation and lightness More...
 
constexpr uint8_t getLuma () const
 get the luma of the color More...
 
uint8_t getLightness () const
 get the lightness of the color More...
 
template<typename T >
constexpr T normRed () const
 get the normalized red value More...
 
template<typename T >
constexpr T normGreen () const
 get the normalized green value More...
 
template<typename T >
constexpr T normBlue () const
 get the normalized blue value More...
 
template<typename T >
constexpr T normAlpha () const
 get the normalized alpha value More...
 
template<typename T >
void setNormRed (T v)
 set the red value normalized More...
 
template<typename T >
void setNormGreen (T v)
 set the green value normalized More...
 
template<typename T >
void setNormBlue (T v)
 set the blue value normalized More...
 
template<typename T >
void setNormAlpha (T v)
 set the alpha value normalized More...
 

Static Public Member Functions

static bool isColorRepresentation (UTF8StringPtr str)
 

Public Attributes

uint8_t red {255}
 red component [0..255] More...
 
uint8_t green {255}
 green component [0..255] More...
 
uint8_t blue {255}
 blue component [0..255] More...
 
uint8_t alpha {255}
 alpha component [0..255] More...
 

Detailed Description

RGBA Color structure.

Constructor & Destructor Documentation

◆ CColor() [1/3]

constexpr CColor ( )
default

◆ CColor() [2/3]

constexpr CColor ( uint8_t  red,
uint8_t  green,
uint8_t  blue,
uint8_t  alpha = 255 
)
inline

◆ CColor() [3/3]

constexpr CColor ( const CColor inColor)
inline

Member Function Documentation

◆ fromHSL()

void fromHSL ( double  hue,
double  saturation,
double  lightness 
)

convert from hue, saturation and lightness

Parameters
huein degree [0..360]
saturationnormalized [0..1]
lightnessnormalized [0..1]

◆ fromHSV()

void fromHSV ( double  hue,
double  saturation,
double  value 
)

convert from hue, saturation and value

Parameters
huein degree [0..360]
saturationnormalized [0..1]
valuenormalized [0..1]

◆ fromString()

bool fromString ( UTF8StringPtr  str)

◆ getLightness()

uint8_t getLightness ( ) const

get the lightness of the color

◆ getLuma()

constexpr uint8_t getLuma ( ) const
inline

get the luma of the color

◆ isColorRepresentation()

bool isColorRepresentation ( UTF8StringPtr  str)
static

◆ normAlpha()

constexpr T normAlpha ( ) const

get the normalized alpha value

◆ normBlue()

constexpr T normBlue ( ) const

get the normalized blue value

◆ normGreen()

constexpr T normGreen ( ) const

get the normalized green value

◆ normRed()

constexpr T normRed ( ) const

get the normalized red value

◆ operator!=()

bool operator!= ( const CColor other) const
inline

◆ operator()()

CColor& operator() ( uint8_t  _red,
uint8_t  _green,
uint8_t  _blue,
uint8_t  _alpha 
)
inline

◆ operator=()

CColor& operator= ( const CColor newColor)
inline

◆ operator==()

bool operator== ( const CColor other) const
inline

◆ setNormAlpha()

void setNormAlpha ( v)

set the alpha value normalized

◆ setNormBlue()

void setNormBlue ( v)

set the blue value normalized

◆ setNormGreen()

void setNormGreen ( v)

set the green value normalized

◆ setNormRed()

void setNormRed ( v)

set the red value normalized

◆ toHSL()

void toHSL ( double &  hue,
double &  saturation,
double &  lightness 
) const

convert to hue, saturation and lightness

Parameters
huein degree [0..360]
saturationnormalized [0..1]
lightnessnormalized [0..1]

◆ toHSV()

void toHSV ( double &  hue,
double &  saturation,
double &  value 
) const

convert to hue, saturation and value

Parameters
huein degree [0..360]
saturationnormalized [0..1]
valuenormalized [0..1]

◆ toString()

UTF8String toString ( ) const

Member Data Documentation

◆ alpha

uint8_t alpha {255}

alpha component [0..255]

◆ blue

uint8_t blue {255}

blue component [0..255]

◆ green

uint8_t green {255}

green component [0..255]

◆ red

uint8_t red {255}

red component [0..255]


The documentation for this struct was generated from the following files: