irr::video::SColorHSL Class Reference

Class representing a color in HSL format. More...

#include <SColor.h>

Public Member Functions
	SColorHSL (f32 h=0.f, f32 s=0.f, f32 l=0.f)
void	fromRGB (const SColorf &color)
void	toRGB (SColorf &color) const

Public Attributes
f32	Hue
f32	Saturation
f32	Luminance

Detailed Description

Class representing a color in HSL format.

The color values for hue, saturation, luminance are stored in 32bit floating point variables. Hue is in range [0,360], Luminance and Saturation are in percent [0,100]

Definition at line 707 of file SColor.h.

Constructor & Destructor Documentation

SColorHSL()

irr::video::SColorHSL::SColorHSL ( f32  h = 0.f, f32  s = 0.f, f32  l = 0.f  )

inline

Definition at line 710 of file SColor.h.

                        : Hue ( h ), Saturation ( s ), Luminance ( l ) {}

Member Function Documentation

fromRGB()

void irr::video::SColorHSL::fromRGB ( const SColorf &  color )

inline

Definition at line 725 of file SColor.h.

        {
                const f32 maxVal = core::max_(color.getRed(), color.getGreen(), color.getBlue());
                const f32 minVal = (f32)core::min_(color.getRed(), color.getGreen(), color.getBlue());
                Luminance = (maxVal+minVal)*50;
                if (core::equals(maxVal, minVal))
                {
                        Hue=0.f;
                        Saturation=0.f;
                        return;
                }

                const f32 delta = maxVal-minVal;
                if ( Luminance <= 50 )
                {
                        Saturation = (delta)/(maxVal+minVal);
                }
                else
                {
                        Saturation = (delta)/(2-maxVal-minVal);
                }
                Saturation *= 100;

                if (core::equals(maxVal, color.getRed()))
                        Hue = (color.getGreen()-color.getBlue())/delta;
                else if (core::equals(maxVal, color.getGreen()))
                        Hue = 2+((color.getBlue()-color.getRed())/delta);
                else // blue is max
                        Hue = 4+((color.getRed()-color.getGreen())/delta);

                Hue *= 60.0f;
                while ( Hue < 0.f )
                        Hue += 360;
        }

toRGB()

void irr::video::SColorHSL::toRGB ( SColorf &  color ) const

inline

Definition at line 761 of file SColor.h.

        {
                const f32 l = Luminance/100;
                if (core::iszero(Saturation)) // grey
                {
                        color.set(l, l, l);
                        return;
                }

                f32 rm2;

                if ( Luminance <= 50 )
                {
                        rm2 = l + l * (Saturation/100);
                }
                else
                {
                        rm2 = l + (1 - l) * (Saturation/100);
                }

                const f32 rm1 = 2.0f * l - rm2;

                const f32 h = Hue / 360.0f;
                color.set( toRGB1(rm1, rm2, h + 1.f/3.f),
                        toRGB1(rm1, rm2, h),
                        toRGB1(rm1, rm2, h - 1.f/3.f)
                        );
        }

Member Data Documentation

Hue

f32 irr::video::SColorHSL::Hue

Definition at line 716 of file SColor.h.

Luminance

f32 irr::video::SColorHSL::Luminance

Definition at line 718 of file SColor.h.

Saturation

f32 irr::video::SColorHSL::Saturation

Definition at line 717 of file SColor.h.

---

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

• include/irrlicht/SColor.h