neoGFX
C++ GPU-oriented GUI library and app/game creation framework.
neogfx::hsl_colour Class Reference

#include <hsl_colour.hpp>

Public Member Functions

 hsl_colour ()
 
 hsl_colour (double aHue, double aSaturation, double aLightness, double aAlpha=1.0)
 
 hsl_colour (const colour &aColour)
 
double hue () const
 
double saturation () const
 
double lightness () const
 
double alpha () const
 
void set_hue (double aHue)
 
void set_saturation (double aSaturation)
 
void set_lightness (double aLightness)
 
void set_alpha (double aAlpha)
 
bool hue_undefined () const
 
hsl_colour with_lightness (double aNewLightness) const
 
hsl_colour lighter (double aDelta) const
 
hsl_colour lighter (double aCoeffecient, double aDelta) const
 
colour to_rgb () const
 
bool operator== (const hsl_colour &aOther) const
 
bool operator!= (const hsl_colour &aOther) const
 
bool operator< (const hsl_colour &aOther) const
 

Static Public Member Functions

static hsl_colour from_rgb (const colour &aColour)
 
static double undefined_hue ()
 

Detailed Description

Definition at line 28 of file hsl_colour.hpp.

Constructor & Destructor Documentation

◆ hsl_colour() [1/3]

neogfx::hsl_colour::hsl_colour ( )

◆ hsl_colour() [2/3]

neogfx::hsl_colour::hsl_colour ( double  aHue,
double  aSaturation,
double  aLightness,
double  aAlpha = 1.0 
)

◆ hsl_colour() [3/3]

neogfx::hsl_colour::hsl_colour ( const colour aColour)

Member Function Documentation

◆ alpha()

double neogfx::hsl_colour::alpha ( ) const

◆ from_rgb()

static hsl_colour neogfx::hsl_colour::from_rgb ( const colour aColour)
static

◆ hue()

double neogfx::hsl_colour::hue ( ) const

◆ hue_undefined()

bool neogfx::hsl_colour::hue_undefined ( ) const

◆ lighter() [1/2]

hsl_colour neogfx::hsl_colour::lighter ( double  aDelta) const

◆ lighter() [2/2]

hsl_colour neogfx::hsl_colour::lighter ( double  aCoeffecient,
double  aDelta 
) const

◆ lightness()

double neogfx::hsl_colour::lightness ( ) const

◆ operator!=()

bool neogfx::hsl_colour::operator!= ( const hsl_colour aOther) const

◆ operator<()

bool neogfx::hsl_colour::operator< ( const hsl_colour aOther) const

◆ operator==()

bool neogfx::hsl_colour::operator== ( const hsl_colour aOther) const

◆ saturation()

double neogfx::hsl_colour::saturation ( ) const

◆ set_alpha()

void neogfx::hsl_colour::set_alpha ( double  aAlpha)

◆ set_hue()

void neogfx::hsl_colour::set_hue ( double  aHue)

◆ set_lightness()

void neogfx::hsl_colour::set_lightness ( double  aLightness)

◆ set_saturation()

void neogfx::hsl_colour::set_saturation ( double  aSaturation)

◆ to_rgb()

colour neogfx::hsl_colour::to_rgb ( ) const

◆ undefined_hue()

static double neogfx::hsl_colour::undefined_hue ( )
static

◆ with_lightness()

hsl_colour neogfx::hsl_colour::with_lightness ( double  aNewLightness) const

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