claw::graphic::rgb_pixel Struct Reference

RGB pixel. More...

#include <pixel.hpp>

List of all members.

Public Types
typedef unsigned char	component_type
Public Member Functions
	rgb_pixel ()
	Default constructor.
	rgb_pixel (component_type r, component_type g, component_type b)
	Constructor.
	rgb_pixel (const rgba_pixel &p)
	Constructor.
bool	operator== (const rgb_pixel &that) const
	Compare to a pixel.
bool	operator== (const rgba_pixel &that) const
	Compare to a pixel.
bool	operator!= (const rgb_pixel &that) const
	Compare to a pixel.
bool	operator!= (const rgba_pixel &that) const
	Compare to a pixel.
Public Attributes
struct {
component_type   red
	Red component.
component_type   green
	Green component.
component_type   blue
	Blue component.
}	components
	Component by component representation.

---

Detailed Description

RGB pixel.

Definition at line 42 of file pixel.hpp.

---

Member Typedef Documentation

typedef unsigned char claw::graphic::rgb_pixel::component_type

Definition at line 44 of file pixel.hpp.

---

Constructor & Destructor Documentation

claw::graphic::rgb_pixel::rgb_pixel

(

)

Default constructor.

Definition at line 76 of file pixel.cpp.

Referenced by operator==().

{

} // rgb_pixel::rgb_pixel()

claw::graphic::rgb_pixel::rgb_pixel	(	component_type	r,
		component_type	g,
		component_type	b
	)

Constructor.

Parameters:

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

Definition at line 89 of file pixel.cpp.

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

claw::graphic::rgb_pixel::rgb_pixel

(

const rgba_pixel &

p

)

Constructor.

Parameters:

p

An RGBA pixel.

Definition at line 101 of file pixel.cpp.

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

{ 
  components.red = p.components.red;
  components.green = p.components.green;
  components.blue = p.components.blue;
} // rgb_pixel::rgb_pixel()

---

Member Function Documentation

bool claw::graphic::rgb_pixel::operator!=

(

const rgb_pixel &

that

)

const

Compare to a pixel.

Parameters:

that

The pixel to compare to.

Definition at line 135 of file pixel.cpp.

{ 
  return !(*this == that);
} // rgb_pixel::operator!=()

bool claw::graphic::rgb_pixel::operator!=

(

const rgba_pixel &

that

)

const

Compare to a pixel.

Parameters:

that

The pixel to compare to.

Definition at line 145 of file pixel.cpp.

{ 
  return !(*this == that);
} // rgb_pixel::operator!=()

bool claw::graphic::rgb_pixel::operator==

(

const rgb_pixel &

that

)

const

Compare to a pixel.

Parameters:

that

The pixel to compare to.

Definition at line 113 of file pixel.cpp.

References blue, components, green, and red.

{ 
  return (components.red == that.components.red)
    && (components.green == that.components.green)
    && (components.blue == that.components.blue);
} // rgb_pixel::operator==()

bool claw::graphic::rgb_pixel::operator==

(

const rgba_pixel &

that

)

const

Compare to a pixel.

Parameters:

that

The pixel to compare to.

Definition at line 125 of file pixel.cpp.

References rgb_pixel().

{ 
  return *this == rgb_pixel(that);
} // rgb_pixel::operator==()

---

Member Data Documentation

component_type claw::graphic::rgb_pixel::blue

Blue component.

Definition at line 56 of file pixel.hpp.

Referenced by claw::graphic::rgba_pixel::operator=(), and operator==().

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

Component by component representation.

Referenced by claw::graphic::rgba_pixel::operator=(), operator==(), and rgb_pixel().

component_type claw::graphic::rgb_pixel::green

Green component.

Definition at line 53 of file pixel.hpp.

Referenced by claw::graphic::rgba_pixel::operator=(), and operator==().

component_type claw::graphic::rgb_pixel::red

Red component.

Definition at line 50 of file pixel.hpp.

Referenced by claw::graphic::rgba_pixel::operator=(), and operator==().

---

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

• pixel.hpp
• code/pixel.cpp