HGL::ImageOutput::ICanvas::RGB Struct Reference

Structure representing a color. More...

#include "icanvas.h"

Public Member Functions
	RGB (uint8_t r, uint8_t g, uint8_t b) throw ()
	Constructor. More...
	RGB (uint32_t index) throw ()
	Constructor. More...
	RGB (const std::string &hexStr) throw ()
	Constructor. More...
virtual	~RGB () throw ()
	Destructor. More...
uint32_t	getColorIndex () const throw ()
	Gets the color index. More...

Public Attributes
uint8_t	alpha
	the alpha value between 0 and 255 More...
uint8_t	blue
	the blue value between 0 and 255 More...
uint8_t	green
	the green value between 0 and 255 More...
uint8_t	red
	the red value between 0 and 255 More...

Detailed Description

Structure representing a color.

Alpha channel disabled, i.e. set to 0xFF

Author

Heiko Schäfer heiko.nosp@m.@hgl.nosp@m..rang.nosp@m.un.d.nosp@m.e

Constructor & Destructor Documentation

HGL::ImageOutput::ICanvas::RGB::RGB	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b
	)
throw	(
	)

Constructor.

Initial is color white with full opacity

Parameters

r	the red value between 0 and 255
g	the green value between 0 and 255
b	the blue value between 0 and 255

HGL::ImageOutput::ICanvas::RGB::RGB	(	uint32_t	index	)
throw	(
	)

Constructor.

Constructs an RGB instance from a 32 bit integer.

The integer should have a hex form like 0xrrggbb.

See Also

RGB(const std::string &hexStr)

Parameters

index

the color index

Since

0.5.4

HGL::ImageOutput::ICanvas::RGB::RGB ( const std::string &  hexStr ) throw ( )

explicit

Constructor.

Parameters

hexStr

a string in the form rrggbbaa

virtual HGL::ImageOutput::ICanvas::RGB::~RGB ( ) throw ( )

virtual

Destructor.

Member Function Documentation

uint32_t HGL::ImageOutput::ICanvas::RGBA::getColorIndex ( ) const throw ( )

inherited

Gets the color index.

Returns

the color index

Since

0.4.49

Member Data Documentation

uint8_t HGL::ImageOutput::ICanvas::RGBA::alpha

inherited

the alpha value between 0 and 255

uint8_t HGL::ImageOutput::ICanvas::RGBA::blue

inherited

the blue value between 0 and 255

uint8_t HGL::ImageOutput::ICanvas::RGBA::green

inherited

the green value between 0 and 255

uint8_t HGL::ImageOutput::ICanvas::RGBA::red

inherited

the red value between 0 and 255