dlr::computerVision::PixelRGB< TYPE > Struct Template Reference

Collaboration diagram for dlr::computerVision::PixelRGB< TYPE >:

[legend]List of all members.

Public Member Functions
	PixelRGB ()
	This constructor makes no guarantees about the color of the pixel.
	PixelRGB (const TYPE &red, const TYPE &green, const TYPE &blue)
	This constructor explicitly sets the pixel value.
	~PixelRGB ()
	The destructor deletes cleans up for deletion.
template<class Iter>
Iter &	copyFromIterator (Iter &iter)
	This member function copies the pixel component values, in order, from consecutive iterator targets, incrementing the iterator after each copy.
template<class Iter>
Iter &	copyToIterator (Iter &iter)
	This member function assigns the pixel component values, in order, to consecutive iterator targets, incrementing the iterator after each assignment.
Static Public Member Functions
static bool	isContiguous ()
	This static member function indicates whether or not a pixel instance is memory identical to a contiguous array of Component type.
Public Attributes
TYPE	red
TYPE	green
TYPE	blue

---

Detailed Description

template<class TYPE>
struct dlr::computerVision::PixelRGB< TYPE >

Definition at line 25 of file pixelRGB.h.

---

Constructor & Destructor Documentation

template<class TYPE>

dlr::computerVision::PixelRGB< TYPE >::PixelRGB

(

)

[inline]

This constructor makes no guarantees about the color of the pixel.

Definition at line 31 of file pixelRGB.h.

template<class TYPE>

dlr::computerVision::PixelRGB< TYPE >::PixelRGB	(	const TYPE &	red,
		const TYPE &	green,
		const TYPE &	blue
	)			[inline]

This constructor explicitly sets the pixel value.

Parameters:

	red	This argument specifies the red value for the new pixel.
	green	This argument specifies the green value for the new pixel.
	blue	This argument specifies the blue value for the new pixel.

Definition at line 44 of file pixelRGB.h.

template<class TYPE>

dlr::computerVision::PixelRGB< TYPE >::~PixelRGB

(

)

[inline]

The destructor deletes cleans up for deletion.

Definition at line 51 of file pixelRGB.h.

---

Member Function Documentation

template<class TYPE>

template<class Iter>

Iter & dlr::computerVision::PixelRGB< TYPE >::copyFromIterator

(

Iter &

iter

)

[inline]

This member function copies the pixel component values, in order, from consecutive iterator targets, incrementing the iterator after each copy.

Parameters:

iter

This argument is the iterator from which to copy the pixel components.

Returns:

The return value is a reference to iter after the copying and incrementing is done.

Definition at line 169 of file pixelRGB.h.

References dlr::computerVision::PixelRGB< TYPE >::blue, dlr::computerVision::PixelRGB< TYPE >::green, and dlr::computerVision::PixelRGB< TYPE >::red.

template<class TYPE>

template<class Iter>

Iter & dlr::computerVision::PixelRGB< TYPE >::copyToIterator

(

Iter &

iter

)

[inline]

This member function assigns the pixel component values, in order, to consecutive iterator targets, incrementing the iterator after each assignment.

Parameters:

iter

This argument is the iterator to which to copy the pixel components.

Returns:

The return value is a reference to iter after the copying and incrementing is done.

Definition at line 185 of file pixelRGB.h.

References dlr::computerVision::PixelRGB< TYPE >::blue, dlr::computerVision::PixelRGB< TYPE >::green, and dlr::computerVision::PixelRGB< TYPE >::red.

template<class TYPE>

bool dlr::computerVision::PixelRGB< TYPE >::isContiguous

(

)

[inline, static]

This static member function indicates whether or not a pixel instance is memory identical to a contiguous array of Component type.

Returns:

The return value is true if the pixel structure is not padded by the compiler.

Definition at line 200 of file pixelRGB.h.

References dlr::computerVision::PixelRGB< TYPE >::blue, dlr::computerVision::PixelRGB< TYPE >::green, and dlr::computerVision::PixelRGB< TYPE >::red.

---

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

• pixelRGB.h

---