irr::video::SColor Class Reference

Class representing a 32 bit ARGB color. More...

#include <SColor.h>

Public Member Functions
	SColor ()
	Constructor of the Color. Does nothing. More...
	SColor (u32 a, u32 r, u32 g, u32 b)
	Constructs the color from 4 values representing the alpha, red, green and blue component. More...
	SColor (u32 clr)
	Constructs the color from a 32 bit value. Could be another color. More...
u32	getAlpha () const
	Returns the alpha component of the color. More...
u32	getRed () const
	Returns the red component of the color. More...
u32	getGreen () const
	Returns the green component of the color. More...
u32	getBlue () const
	Returns the blue component of the color. More...
f32	getLightness () const
	Get lightness of the color in the range [0,255]. More...
f32	getLuminance () const
	Get luminance of the color in the range [0,255]. More...
u32	getAverage () const
	Get average intensity of the color in the range [0,255]. More...
void	setAlpha (u32 a)
	Sets the alpha component of the Color. More...
void	setRed (u32 r)
	Sets the red component of the Color. More...
void	setGreen (u32 g)
	Sets the green component of the Color. More...
void	setBlue (u32 b)
	Sets the blue component of the Color. More...
u16	toA1R5G5B5 () const
	Calculates a 16 bit A1R5G5B5 value of this color. More...
void	toOpenGLColor (u8 *dest) const
	Converts color to OpenGL color format. More...
void	set (u32 a, u32 r, u32 g, u32 b)
	Sets all four components of the color at once. More...
void	set (u32 col)
bool	operator== (const SColor &other) const
	Compares the color to another color. More...
bool	operator!= (const SColor &other) const
	Compares the color to another color. More...
bool	operator< (const SColor &other) const
	comparison operator More...
SColor	operator+ (const SColor &other) const
	Adds two colors, result is clamped to 0..255 values. More...
SColor	getInterpolated (const SColor &other, f32 d) const
	Interpolates the color with a f32 value to another color. More...
SColor	getInterpolated_quadratic (const SColor &c1, const SColor &c2, f32 d) const
	Returns interpolated color. ( quadratic ) More...
void	setData (const void *data, ECOLOR_FORMAT format)
	set the color by expecting data in the given format More...
void	getData (void *data, ECOLOR_FORMAT format) const
	Write the color to data in the defined format. More...

Public Attributes
u32	color
	color in A8R8G8B8 Format More...

Detailed Description

Class representing a 32 bit ARGB color.

The color values for alpha, red, green, and blue are stored in a single u32. So all four values may be between 0 and 255. Alpha in Irrlicht is opacity, so 0 is fully transparent, 255 is fully opaque (solid). This class is used by most parts of the Irrlicht Engine to specify a color. Another way is using the class SColorf, which stores the color values in 4 floats. This class must consist of only one u32 and must not use virtual functions.

Definition at line 316 of file SColor.h.

Constructor & Destructor Documentation

SColor() [1/3]

irr::video::SColor::SColor ( )

inline

Constructor of the Color. Does nothing.

The color value is not initialized to save time.

Definition at line 322 of file SColor.h.

{}

SColor() [2/3]

irr::video::SColor::SColor ( u32  a, u32  r, u32  g, u32  b  )

inline

Constructs the color from 4 values representing the alpha, red, green and blue component.

Must be values between 0 and 255.

Definition at line 326 of file SColor.h.

                        : color(((a & 0xff)<<24) | ((r & 0xff)<<16) | ((g & 0xff)<<8) | (b & 0xff)) {}

SColor() [3/3]

irr::video::SColor::SColor ( u32  clr )

inline

Constructs the color from a 32 bit value. Could be another color.

Definition at line 330 of file SColor.h.

                        : color(clr) {}

Member Function Documentation

getAlpha()

u32 irr::video::SColor::getAlpha ( ) const

inline

Returns the alpha component of the color.

The alpha component defines how opaque a color is.

Returns

The alpha value of the color. 0 is fully transparent, 255 is fully opaque.

Definition at line 336 of file SColor.h.

{ return color>>24; }

getAverage()

u32 irr::video::SColor::getAverage ( ) const

inline

Get average intensity of the color in the range [0,255].

Definition at line 366 of file SColor.h.

                {
                        return ( getRed() + getGreen() + getBlue() ) / 3;
                }

getBlue()

u32 irr::video::SColor::getBlue ( ) const

inline

Returns the blue component of the color.

Returns

Value between 0 and 255, specifying how blue the color is. 0 means no blue, 255 means full blue.

Definition at line 351 of file SColor.h.

{ return color & 0xff; }

getData()

void irr::video::SColor::getData ( void *  data, ECOLOR_FORMAT  format  ) const

inline

Write the color to data in the defined format.

Parameters

data	target to write the color. Must contain sufficiently large memory to receive the number of bytes neede for format
format	tells the format used to write the color into data

Definition at line 522 of file SColor.h.

                {
                        switch(format)
                        {
                                case ECF_A1R5G5B5:
                                {
                                        u16 * dest = (u16*)data;
                                        *dest = video::A8R8G8B8toA1R5G5B5( color );
                                }
                                break;

                                case ECF_R5G6B5:
                                {
                                        u16 * dest = (u16*)data;
                                        *dest = video::A8R8G8B8toR5G6B5( color );
                                }
                                break;

                                case ECF_R8G8B8:
                                {
                                        u8* dest = (u8*)data;
                                        dest[0] = (u8)getRed();
                                        dest[1] = (u8)getGreen();
                                        dest[2] = (u8)getBlue();
                                }
                                break;

                                case ECF_A8R8G8B8:
                                {
                                        u32 * dest = (u32*)data;
                                        *dest = color;
                                }
                                break;

                                default:
                                break;
                        }
                }

getGreen()

u32 irr::video::SColor::getGreen ( ) const

inline

Returns the green component of the color.

Returns

Value between 0 and 255, specifying how green the color is. 0 means no green, 255 means full green.

Definition at line 346 of file SColor.h.

{ return (color>>8) & 0xff; }

getInterpolated()

SColor irr::video::SColor::getInterpolated ( const SColor &  other, f32  d  ) const

inline

Interpolates the color with a f32 value to another color.

Parameters

other	Other color
d	value between 0.0f and 1.0f. d=0 returns other, d=1 returns this, values between interpolate.

Returns

Interpolated color.

Definition at line 455 of file SColor.h.

                {
                        d = core::clamp(d, 0.f, 1.f);
                        const f32 inv = 1.0f - d;
                        return SColor((u32)core::round32(other.getAlpha()*inv + getAlpha()*d),
                                (u32)core::round32(other.getRed()*inv + getRed()*d),
                                (u32)core::round32(other.getGreen()*inv + getGreen()*d),
                                (u32)core::round32(other.getBlue()*inv + getBlue()*d));
                }

getInterpolated_quadratic()

SColor irr::video::SColor::getInterpolated_quadratic ( const SColor &  c1, const SColor &  c2, f32  d  ) const

inline

Returns interpolated color. ( quadratic )

Parameters

c1	first color to interpolate with
c2	second color to interpolate with
d	value between 0.0f and 1.0f.

Definition at line 469 of file SColor.h.

                {
                        // this*(1-d)*(1-d) + 2 * c1 * (1-d) + c2 * d * d;
                        d = core::clamp(d, 0.f, 1.f);
                        const f32 inv = 1.f - d;
                        const f32 mul0 = inv * inv;
                        const f32 mul1 = 2.f * d * inv;
                        const f32 mul2 = d * d;

                        return SColor(
                                        core::clamp( core::floor32(
                                                        getAlpha() * mul0 + c1.getAlpha() * mul1 + c2.getAlpha() * mul2 ), 0, 255 ),
                                        core::clamp( core::floor32(
                                                        getRed()   * mul0 + c1.getRed()   * mul1 + c2.getRed()   * mul2 ), 0, 255 ),
                                        core::clamp ( core::floor32(
                                                        getGreen() * mul0 + c1.getGreen() * mul1 + c2.getGreen() * mul2 ), 0, 255 ),
                                        core::clamp ( core::floor32(
                                                        getBlue()  * mul0 + c1.getBlue()  * mul1 + c2.getBlue()  * mul2 ), 0, 255 ));
                }

getLightness()

f32 irr::video::SColor::getLightness ( ) const

inline

Get lightness of the color in the range [0,255].

Definition at line 354 of file SColor.h.

                {
                        return 0.5f*(core::max_(core::max_(getRed(),getGreen()),getBlue())+core::min_(core::min_(getRed(),getGreen()),getBlue()));
                }

getLuminance()

f32 irr::video::SColor::getLuminance ( ) const

inline

Get luminance of the color in the range [0,255].

Definition at line 360 of file SColor.h.

                {
                        return 0.3f*getRed() + 0.59f*getGreen() + 0.11f*getBlue();
                }

getRed()

u32 irr::video::SColor::getRed ( ) const

inline

Returns the red component of the color.

Returns

Value between 0 and 255, specifying how red the color is. 0 means no red, 255 means full red.

Definition at line 341 of file SColor.h.

{ return (color>>16) & 0xff; }

operator!=()

bool irr::video::SColor::operator!= ( const SColor &  other ) const

inline

Compares the color to another color.

Returns

True if the colors are different, and false if they are the same.

Definition at line 434 of file SColor.h.

{ return other.color != color; }

operator+()

SColor irr::video::SColor::operator+ ( const SColor &  other ) const

inline

Adds two colors, result is clamped to 0..255 values.

Parameters

other

Color to add to this color

Returns

Addition of the two colors, clamped to 0..255 values

Definition at line 443 of file SColor.h.

                {
                        return SColor(core::min_(getAlpha() + other.getAlpha(), 255u),
                                        core::min_(getRed() + other.getRed(), 255u),
                                        core::min_(getGreen() + other.getGreen(), 255u),
                                        core::min_(getBlue() + other.getBlue(), 255u));
                }

operator<()

bool irr::video::SColor::operator< ( const SColor &  other ) const

inline

comparison operator

Returns

True if this color is smaller than the other one

Definition at line 438 of file SColor.h.

{ return (color < other.color); }

operator==()

bool irr::video::SColor::operator== ( const SColor &  other ) const

inline

Compares the color to another color.

Returns

True if the colors are the same, and false if not.

Definition at line 430 of file SColor.h.

{ return other.color == color; }

set() [1/2]

void irr::video::SColor::set ( u32  a, u32  r, u32  g, u32  b  )

inline

Sets all four components of the color at once.

Constructs the color from 4 values representing the alpha, red, green and blue components of the color. Must be values between 0 and 255.

Parameters

a	Alpha component of the color. The alpha component defines how transparent a color should be. Has to be a value between 0 and 255. 255 means not transparent (opaque), 0 means fully transparent.
r	Sets the red component of the Color. Has to be a value between 0 and 255. 0 means no red, 255 means full red.
g	Sets the green component of the Color. Has to be a value between 0 and 255. 0 means no green, 255 means full green.
b	Sets the blue component of the Color. Has to be a value between 0 and 255. 0 means no blue, 255 means full blue.

Definition at line 422 of file SColor.h.

                {
                        color = (((a & 0xff)<<24) | ((r & 0xff)<<16) | ((g & 0xff)<<8) | (b & 0xff));
                }

set() [2/2]

void irr::video::SColor::set ( u32  col )

inline

Definition at line 426 of file SColor.h.

{ color = col; }

setAlpha()

void irr::video::SColor::setAlpha ( u32  a )

inline

Sets the alpha component of the Color.

The alpha component defines how transparent a color should be.

Parameters

a	The alpha value of the color. 0 is fully transparent, 255 is fully opaque.

Definition at line 374 of file SColor.h.

{ color = ((a & 0xff)<<24) | (color & 0x00ffffff); }

setBlue()

void irr::video::SColor::setBlue ( u32  b )

inline

Sets the blue component of the Color.

Parameters

b	Has to be a value between 0 and 255. 0 means no blue, 255 means full blue.

Definition at line 389 of file SColor.h.

{ color = (b & 0xff) | (color & 0xffffff00); }

setData()

void irr::video::SColor::setData ( const void *  data, ECOLOR_FORMAT  format  )

inline

set the color by expecting data in the given format

Parameters

data	must point to valid memory containing color information in the given format
format	tells the format in which data is available

Definition at line 493 of file SColor.h.

                {
                        switch (format)
                        {
                                case ECF_A1R5G5B5:
                                        color = A1R5G5B5toA8R8G8B8(*(u16*)data);
                                        break;
                                case ECF_R5G6B5:
                                        color = R5G6B5toA8R8G8B8(*(u16*)data);
                                        break;
                                case ECF_A8R8G8B8:
                                        color = *(u32*)data;
                                        break;
                                case ECF_R8G8B8:
                                        {
                                                const u8* p = (u8*)data;
                                                set(255, p[0],p[1],p[2]);
                                        }
                                        break;
                                default:
                                        color = 0xffffffff;
                                break;
                        }
                }

setGreen()

void irr::video::SColor::setGreen ( u32  g )

inline

Sets the green component of the Color.

Parameters

g	Has to be a value between 0 and 255. 0 means no green, 255 means full green.

Definition at line 384 of file SColor.h.

{ color = ((g & 0xff)<<8) | (color & 0xffff00ff); }

setRed()

void irr::video::SColor::setRed ( u32  r )

inline

Sets the red component of the Color.

Parameters

r	Has to be a value between 0 and 255. 0 means no red, 255 means full red.

Definition at line 379 of file SColor.h.

{ color = ((r & 0xff)<<16) | (color & 0xff00ffff); }

toA1R5G5B5()

u16 irr::video::SColor::toA1R5G5B5 ( ) const

inline

Calculates a 16 bit A1R5G5B5 value of this color.

Returns

16 bit A1R5G5B5 value of this color.

Definition at line 393 of file SColor.h.

{ return A8R8G8B8toA1R5G5B5(color); }

toOpenGLColor()

void irr::video::SColor::toOpenGLColor ( u8 *  dest ) const

inline

Converts color to OpenGL color format.

From ARGB to RGBA in 4 byte components for endian aware passing to OpenGL

Parameters

dest	address where the 4x8 bit OpenGL color is stored.

Definition at line 399 of file SColor.h.

                {
                        *dest =   (u8)getRed();
                        *++dest = (u8)getGreen();
                        *++dest = (u8)getBlue();
                        *++dest = (u8)getAlpha();
                }

Member Data Documentation

color

u32 irr::video::SColor::color

color in A8R8G8B8 Format

Definition at line 562 of file SColor.h.

---

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

• include/irrlicht/SColor.h