LibCarna::base::Color Class Reference

Represents a color. Objects from this class are copyable and assignable. More...

#include <Color.hpp>

Collaboration diagram for LibCarna::base::Color:

Public Member Functions
	Color (const math::Vector4f &)
	Instantiates from floating point values, clamped to interval \(\left[0, 1\right]\).
	Color (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Instantiates.
	Color ()
	Instantiates with BLACK_NO_ALPHA.
	operator math::Vector4f () const
	Converts to floating point representation with values in interval \(\left[0, 1\right]\).
bool	operator== (const Color &other) const
	Compares to other.
bool	operator< (const Color &other) const
	Compares to other.
Color &	operator= (const Color &other)
	Assigns values from other.

Public Attributes
unsigned char	r
	Holds the red component.
unsigned char	g
	Holds the green component.
unsigned char	b
	Holds the blue component.
unsigned char	a
	Holds the alpha component.

Static Public Attributes
static const Color	WHITE
	Holds Color(255, 255, 255, 255).
static const Color	WHITE_NO_ALPHA
	Holds Color(255, 255, 255, 0).
static const Color	BLACK
	Holds Color(0, 0, 0, 255).
static const Color	BLACK_NO_ALPHA
	Holds Color(0, 0, 0, 0).
static const Color	RED
	Holds Color(255, 0, 0, 255).
static const Color	RED_NO_ALPHA
	Holds Color(255, 0, 0, 0).
static const Color	GREEN
	Holds Color(0, 255, 0, 255).
static const Color	GREEN_NO_ALPHA
	Holds Color(0, 255, 0, 0).
static const Color	BLUE
	Holds Color(0, 0, 255, 255).
static const Color	BLUE_NO_ALPHA
	Holds Color(0, 0, 255, 0).

Detailed Description

Represents a color. Objects from this class are copyable and assignable.

Author

Leonid Kostrykin

Definition at line 44 of file Color.hpp.

Member Data Documentation

a

unsigned char LibCarna::base::Color::a

Holds the alpha component.

Definition at line 79 of file Color.hpp.

b

unsigned char LibCarna::base::Color::b

Holds the blue component.

Definition at line 78 of file Color.hpp.

BLACK

const Color LibCarna::base::Color::BLACK

static

Holds Color(0, 0, 0, 255).

Definition at line 51 of file Color.hpp.

BLACK_NO_ALPHA

const Color LibCarna::base::Color::BLACK_NO_ALPHA

static

Holds Color(0, 0, 0, 0).

Definition at line 52 of file Color.hpp.

BLUE

const Color LibCarna::base::Color::BLUE

static

Holds Color(0, 0, 255, 255).

Definition at line 57 of file Color.hpp.

BLUE_NO_ALPHA

const Color LibCarna::base::Color::BLUE_NO_ALPHA

static

Holds Color(0, 0, 255, 0).

Definition at line 58 of file Color.hpp.

g

unsigned char LibCarna::base::Color::g

Holds the green component.

Definition at line 77 of file Color.hpp.

GREEN

const Color LibCarna::base::Color::GREEN

static

Holds Color(0, 255, 0, 255).

Definition at line 55 of file Color.hpp.

GREEN_NO_ALPHA

const Color LibCarna::base::Color::GREEN_NO_ALPHA

static

Holds Color(0, 255, 0, 0).

Definition at line 56 of file Color.hpp.

r

unsigned char LibCarna::base::Color::r

Holds the red component.

Definition at line 76 of file Color.hpp.

RED

const Color LibCarna::base::Color::RED

static

Holds Color(255, 0, 0, 255).

Definition at line 53 of file Color.hpp.

RED_NO_ALPHA

const Color LibCarna::base::Color::RED_NO_ALPHA

static

Holds Color(255, 0, 0, 0).

Definition at line 54 of file Color.hpp.

WHITE

const Color LibCarna::base::Color::WHITE

static

Holds Color(255, 255, 255, 255).

Definition at line 49 of file Color.hpp.

WHITE_NO_ALPHA

const Color LibCarna::base::Color::WHITE_NO_ALPHA

static

Holds Color(255, 255, 255, 0).

Definition at line 50 of file Color.hpp.

---

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

• include/LibCarna/base/Color.hpp