Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials |
Class representing a color with four floats. More...
#include <SColor.h>
Public Member Functions | |
f32 | getAlpha () const |
Returns the alpha component of the color in the range 0.0 (transparent) to 1.0 (opaque) | |
f32 | getBlue () const |
Returns the blue component of the color in the range 0.0 to 1.0. | |
f32 | getGreen () const |
Returns the green component of the color in the range 0.0 to 1.0. | |
SColorf | getInterpolated (const SColorf &other, f32 d) const |
Interpolates the color with a f32 value to another color. | |
SColorf | getInterpolated_quadratic (const SColorf &c1, const SColorf &c2, f32 d) const |
Returns interpolated color. ( quadratic ) | |
f32 | getRed () const |
Returns the red component of the color in the range 0.0 to 1.0. | |
SColorf () | |
Default constructor for SColorf. | |
SColorf (f32 r, f32 g, f32 b, f32 a=1.0f) | |
Constructs a color from up to four color values: red, green, blue, and alpha. | |
SColorf (SColor c) | |
Constructs a color from 32 bit Color. | |
void | set (f32 rr, f32 gg, f32 bb) |
Sets three color components to new values at once. | |
void | set (f32 aa, f32 rr, f32 gg, f32 bb) |
Sets all four color components to new values at once. | |
void | setColorComponentValue (s32 index, f32 value) |
Sets a color component by index. R=0, G=1, B=2, A=3. | |
SColor | toSColor () const |
Converts this color to a SColor without floats. | |
Public Attributes | |
f32 | a |
alpha color component | |
f32 | b |
blue component | |
f32 | g |
green color component | |
f32 | r |
red color component |
Class representing a color with four floats.
The color values for red, green, blue and alpha are each stored in a 32 bit floating point variable. So all four values may be between 0.0f and 1.0f. Another, faster way to define colors is using the class SColor, which stores the color values in a single 32 bit integer.
irr::video::SColorf::SColorf | ( | ) | [inline] |
Default constructor for SColorf.
Sets red, green and blue to 0.0f and alpha to 1.0f.
Definition at line 347 of file SColor.h.
Referenced by getInterpolated(), and getInterpolated_quadratic().
irr::video::SColorf::SColorf | ( | f32 | r, |
f32 | g, | ||
f32 | b, | ||
f32 | a = 1.0f |
||
) | [inline] |
Constructs a color from up to four color values: red, green, blue, and alpha.
r,: | Red color component. Should be a value between 0.0f meaning no red and 1.0f, meaning full red. |
g,: | Green color component. Should be a value between 0.0f meaning no green and 1.0f, meaning full green. |
b,: | Blue color component. Should be a value between 0.0f meaning no blue and 1.0f, meaning full blue. |
a,: | Alpha color component of the color. The alpha component defines how transparent a color should be. Has to be a value between 0.0f and 1.0f, 1.0f means not transparent (opaque), 0.0f means fully transparent. |
irr::video::SColorf::SColorf | ( | SColor | c | ) | [inline] |
Constructs a color from 32 bit Color.
c,: | 32 bit color from which this SColorf class is constructed from. |
Definition at line 365 of file SColor.h.
References a, b, g, irr::video::SColor::getAlpha(), irr::video::SColor::getBlue(), irr::video::SColor::getGreen(), irr::video::SColor::getRed(), and r.
f32 irr::video::SColorf::getAlpha | ( | ) | const [inline] |
f32 irr::video::SColorf::getBlue | ( | ) | const [inline] |
f32 irr::video::SColorf::getGreen | ( | ) | const [inline] |
SColorf irr::video::SColorf::getInterpolated | ( | const SColorf & | other, |
f32 | d | ||
) | const [inline] |
SColorf irr::video::SColorf::getInterpolated_quadratic | ( | const SColorf & | c1, |
const SColorf & | c2, | ||
f32 | d | ||
) | const [inline] |
f32 irr::video::SColorf::getRed | ( | ) | const [inline] |
void irr::video::SColorf::set | ( | f32 | rr, |
f32 | gg, | ||
f32 | bb | ||
) | [inline] |
Sets three color components to new values at once.
rr,: | Red color component. Should be a value between 0.0f meaning no red (=black) and 1.0f, meaning full red. |
gg,: | Green color component. Should be a value between 0.0f meaning no green (=black) and 1.0f, meaning full green. |
bb,: | Blue color component. Should be a value between 0.0f meaning no blue (=black) and 1.0f, meaning full blue. |
void irr::video::SColorf::set | ( | f32 | aa, |
f32 | rr, | ||
f32 | gg, | ||
f32 | bb | ||
) | [inline] |
Sets all four color components to new values at once.
aa,: | Alpha component. Should be a value between 0.0f meaning fully transparent and 1.0f, meaning opaque. |
rr,: | Red color component. Should be a value between 0.0f meaning no red and 1.0f, meaning full red. |
gg,: | Green color component. Should be a value between 0.0f meaning no green and 1.0f, meaning full green. |
bb,: | Blue color component. Should be a value between 0.0f meaning no blue and 1.0f, meaning full blue. |
void irr::video::SColorf::setColorComponentValue | ( | s32 | index, |
f32 | value | ||
) | [inline] |
SColor irr::video::SColorf::toSColor | ( | ) | const [inline] |
alpha color component
Definition at line 467 of file SColor.h.
Referenced by getAlpha(), getInterpolated(), getInterpolated_quadratic(), SColorf(), set(), setColorComponentValue(), and toSColor().
blue component
Definition at line 464 of file SColor.h.
Referenced by getBlue(), getInterpolated(), getInterpolated_quadratic(), SColorf(), set(), setColorComponentValue(), and toSColor().
green color component
Definition at line 461 of file SColor.h.
Referenced by getGreen(), getInterpolated(), getInterpolated_quadratic(), SColorf(), set(), setColorComponentValue(), and toSColor().
red color component
Definition at line 458 of file SColor.h.
Referenced by getInterpolated(), getInterpolated_quadratic(), getRed(), SColorf(), set(), setColorComponentValue(), and toSColor().
The Irrlicht
Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Fri May 25 2012 04:23:53 by Doxygen
(1.7.6.1) |