claw::graphic::rgba_pixel Struct Reference

RGBA pixel. More...

#include <pixel.hpp>

Classes
union	[union].__unnamed0__

Public Types
typedef unsigned char	component_type
	The type of the components of the color.

Public Member Functions
	rgba_pixel ()
	Default constructor.
	rgba_pixel (const rgb_pixel &that)
	Constructor.
	rgba_pixel (component_type r, component_type g, component_type b, component_type a)
	Constructor.
	rgba_pixel (const std::string &c)
	Constructor from a color name or code.
rgba_pixel &	operator= (const rgb_pixel &that)
	Assignement operator.
bool	operator== (const rgba_pixel &that) const
	Tell if two pixels are equal.
bool	operator!= (const rgba_pixel &that) const
	Tell if two pixels are different.
component_type	luminosity () const
	Get the luminosity of the pixel.

Public Attributes
union

Detailed Description

RGBA pixel.

Definition at line 79 of file pixel.hpp.

Member Typedef Documentation

component_type

typedef unsigned char claw::graphic::rgba_pixel::component_type

The type of the components of the color.

Definition at line 82 of file pixel.hpp.

Constructor & Destructor Documentation

rgba_pixel() [1/4]

claw::graphic::rgba_pixel::rgba_pixel

(

)

Default constructor.

Definition at line 179 of file pixel.cpp.

rgba_pixel() [2/4]

claw::graphic::rgba_pixel::rgba_pixel

(

const rgb_pixel &

that

)

Constructor.

Parameters

that	The other pixel.

Remarks

The alpha component of this is set to 255.

Definition at line 187 of file pixel.cpp.

rgba_pixel() [3/4]

claw::graphic::rgba_pixel::rgba_pixel	(	component_type	r,
		component_type	g,
		component_type	b,
		component_type	a )

Constructor.

Parameters

r	The value of the red field.
g	The value of the green field.
b	The value of the blue field.
a	The value of the alpha field.

Definition at line 202 of file pixel.cpp.

rgba_pixel() [4/4]

claw::graphic::rgba_pixel::rgba_pixel ( const std::string & c )

explicit

Constructor from a color name or code.

Parameters

c	The color name or code.

Definition at line 215 of file pixel.cpp.

Member Function Documentation

luminosity()

claw::graphic::rgba_pixel::component_type claw::graphic::rgba_pixel::luminosity

(

)

const

Get the luminosity of the pixel.

Returns

The luminosity between 0 (dark) and 255 (light).

The luminosity is approximated with integers:

Definition at line 286 of file pixel.cpp.

operator!=()

bool claw::graphic::rgba_pixel::operator!=

(

const rgba_pixel &

that

)

const

Tell if two pixels are different.

Parameters

that	The other pixel.

Definition at line 271 of file pixel.cpp.

operator=()

claw::graphic::rgba_pixel & claw::graphic::rgba_pixel::operator=

(

const rgb_pixel &

that

)

Assignement operator.

Parameters

that	The other pixel.

Remarks

The alpha component of this is set to 255.

Definition at line 248 of file pixel.cpp.

operator==()

bool claw::graphic::rgba_pixel::operator==

(

const rgba_pixel &

that

)

const

Tell if two pixels are equal.

Parameters

that	The other pixel.

Definition at line 262 of file pixel.cpp.

---

The documentation for this struct was generated from the following files:

• lib/graphic/include/claw/graphic/pixel.hpp
• lib/graphic/src/claw/graphic/pixel.cpp