claw::graphic::rgba_pixel Union Reference

RGBA pixel. More...

#include <pixel.hpp>

List of all members.

Public Types
typedef unsigned char	component_type
Public Member Functions
	rgba_pixel ()
	Default constructor.
	rgba_pixel (component_type r, component_type g, component_type b, component_type a)
	Constructor.
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
unsigned int	pixel
	Compressed representation.
struct {
component_type   red
	Red component.
component_type   green
	Green component.
component_type   blue
	Blue component.
component_type   alpha
	Translucy.
}	components
	Component by component representation.

---

Detailed Description

RGBA pixel.

Definition at line 75 of file pixel.hpp.

---

Member Typedef Documentation

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

Definition at line 77 of file pixel.hpp.

---

Constructor & Destructor Documentation

claw::graphic::rgba_pixel::rgba_pixel

(

)

Default constructor.

Definition at line 157 of file pixel.cpp.

{

} // rgba_pixel::rgba_pixel()

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 171 of file pixel.cpp.

{ 
  components.red = r;
  components.green = g;
  components.blue = b;
  components.alpha = a;
} // rgba_pixel::rgba_pixel()

---

Member Function Documentation

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 227 of file pixel.cpp.

References components.

{
  return ((unsigned int)components.red * 183 
          + (unsigned int)components.green * 54 
          + (unsigned int)components.blue * 18
          ) / 256;
} // rgba_pixel::luminosity()

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 211 of file pixel.cpp.

References pixel.

{
  return pixel != that.pixel;
} // rgba_pixel::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 the this is set to 255.

Definition at line 186 of file pixel.cpp.

References claw::graphic::rgb_pixel::blue, claw::graphic::rgb_pixel::components, components, claw::graphic::rgb_pixel::green, and claw::graphic::rgb_pixel::red.

{
  components.red = that.components.red;
  components.green = that.components.green;
  components.blue = that.components.blue;
  components.alpha = 255;

  return *this;
} // rgba_pixel::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 201 of file pixel.cpp.

References pixel.

{
  return pixel == that.pixel;
} // rgba_pixel::operator==()

---

Member Data Documentation

component_type claw::graphic::rgba_pixel::alpha

Translucy.

Definition at line 95 of file pixel.hpp.

Referenced by claw::graphic::targa::reader::file_input_buffer< Pixel >::get_pixel(), claw::graphic::jpeg::reader::grayscale_to_pixel32::operator()(), claw::graphic::jpeg::reader::RGB_to_pixel32::operator()(), and claw::graphic::targa::writer::file_output_buffer< Pixel >::order_pixel_bytes().

component_type claw::graphic::rgba_pixel::blue

Blue component.

Definition at line 92 of file pixel.hpp.

Referenced by claw::graphic::targa::reader::file_input_buffer< Pixel >::get_pixel(), claw::graphic::jpeg::reader::grayscale_to_pixel32::operator()(), claw::graphic::jpeg::reader::RGB_to_pixel32::operator()(), claw::graphic::targa::writer::file_output_buffer< Pixel >::order_pixel_bytes(), and claw::graphic::rgb_pixel::rgb_pixel().

struct { ... } claw::graphic::rgba_pixel::components

Component by component representation.

Referenced by claw::graphic::targa::reader::file_input_buffer< Pixel >::get_pixel(), luminosity(), claw::graphic::jpeg::reader::grayscale_to_pixel32::operator()(), claw::graphic::jpeg::reader::RGB_to_pixel32::operator()(), operator=(), claw::graphic::targa::writer::file_output_buffer< Pixel >::order_pixel_bytes(), and claw::graphic::rgb_pixel::rgb_pixel().

component_type claw::graphic::rgba_pixel::green

Green component.

Definition at line 89 of file pixel.hpp.

Referenced by claw::graphic::targa::reader::file_input_buffer< Pixel >::get_pixel(), claw::graphic::jpeg::reader::grayscale_to_pixel32::operator()(), claw::graphic::jpeg::reader::RGB_to_pixel32::operator()(), claw::graphic::targa::writer::file_output_buffer< Pixel >::order_pixel_bytes(), and claw::graphic::rgb_pixel::rgb_pixel().

unsigned int claw::graphic::rgba_pixel::pixel

Compressed representation.

Definition at line 80 of file pixel.hpp.

Referenced by operator!=(), and operator==().

component_type claw::graphic::rgba_pixel::red

Red component.

Definition at line 86 of file pixel.hpp.

Referenced by claw::graphic::targa::reader::file_input_buffer< Pixel >::get_pixel(), claw::graphic::jpeg::reader::grayscale_to_pixel32::operator()(), claw::graphic::jpeg::reader::RGB_to_pixel32::operator()(), claw::graphic::targa::writer::file_output_buffer< Pixel >::order_pixel_bytes(), and claw::graphic::rgb_pixel::rgb_pixel().

---

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

• pixel.hpp
• code/pixel.cpp