kn::ImageGS< T > Class Template Reference

Class for Grey Scale image. More...

#include <ImageGS.hpp>

Inherits Image< T >.

Collaboration diagram for kn::ImageGS< T >:

[legend]

List of all members.

Public Member Functions
	ImageGS ()
	Constructor to build a 0 size image.
	ImageGS (const size_t w, const size_t h, T *buffer=NULL)
	Constructor to build an allocated empty image Grey Scale or an image from a raw data buffer.
	ImageGS (const ImageGS &e)
	Copy Constructor.
virtual	~ImageGS ()
	dealoccates image data
virtual T &	at (const unsigned int x, const unsigned int y)
	get value of the asked pixel (with bounds checking)
virtual T &	operator() (const unsigned int x, const unsigned int y)
	get value of the asked pixel

---

Detailed Description

template<typename T>
class kn::ImageGS< T >

Class for Grey Scale image.

Definition at line 53 of file ImageGS.hpp.

---

Constructor & Destructor Documentation

template<typename T >

kn::ImageGS< T >::ImageGS

(

)

[inline]

Constructor to build a 0 size image.

Definition at line 110 of file ImageGS.hpp.

template<typename T >

kn::ImageGS< T >::ImageGS	(	const size_t	w,
		const size_t	h,
		T *	buffer = NULL
	)			[inline]

Constructor to build an allocated empty image Grey Scale or an image from a raw data buffer.

Parameters:

	w	width of the image
	h	height of the image
	buffer	optional data buffer WHICH IS NOT COPYIED

Definition at line 115 of file ImageGS.hpp.

template<typename T >

kn::ImageGS< T >::ImageGS

(

const ImageGS< T > &

e

)

[inline]

Copy Constructor.

Parameters:

e

Image to clone

Definition at line 120 of file ImageGS.hpp.

template<typename T >

kn::ImageGS< T >::~ImageGS

(

void

)

[inline, virtual]

dealoccates image data

Definition at line 124 of file ImageGS.hpp.

---

Member Function Documentation

template<typename T>

virtual T& kn::ImageGS< T >::at	(	const unsigned int	x,
		const unsigned int	y
	)			[inline, virtual]

get value of the asked pixel (with bounds checking)

Parameters:

	x	width position of the pixel
	y	height position of the pixel

Returns:

a value of the pixel

Definition at line 82 of file ImageGS.hpp.

template<typename T>

virtual T& kn::ImageGS< T >::operator()	(	const unsigned int	x,
		const unsigned int	y
	)			[inline, virtual]

get value of the asked pixel

Parameters:

	x	width position of the pixel
	y	height position of the pixel

Returns:

a value of the pixel

Definition at line 96 of file ImageGS.hpp.

---

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

• /home/fayn/OpenKraken-dev/OpenKN-image/src/ImageGS.hpp