Référence de la classe Castor::Pixel< FT > (modèle)

Définition d'un pixel. Plus de détails...

Liste de tous les membres

Types publics
typedef byte *	iterator
	Typedef d'un pointeur sur un byte.
typedef byte const *	const_iterator
	Typedef d'un pointeur constant sur un byte.
Fonctions membres publiques
	Pixel (bool p_bInit=false)
	Constructeur.
	Pixel (byte *p_components)
	Constructeur.
	Pixel (Pixel const &p_pxl)
	Constructeur par copie.
	Pixel (Pixel &&p_pxl)
	Constructeur par déplacement.
template<ePIXEL_FORMAT FU>
	Pixel (array< byte, pixel_definitions< FU >::size > const &p_components)
	Constructeur.
template<ePIXEL_FORMAT FU>
	Pixel (Pixel< FU > const &p_pxl)
	Constructeur.
virtual	~Pixel ()
	Destructeur.
Pixel &	operator= (Pixel &&p_pxl)
	Opérateur d'affectation par copie.
Pixel &	operator= (Pixel const &p_pxl)
	Opérateur d'affectation par déplacement.
template<ePIXEL_FORMAT FU>
Pixel &	operator= (Pixel< FU > const &p_pxl)
	Opérateur d'affectation par copie.
template<ePIXEL_FORMAT FU>
Pixel &	operator+= (Pixel< FU > const &p_px)
	Opérateur d'affectation par addition.
template<typename U >
Pixel &	operator+= (U const &p_t)
	Opérateur d'affectation par addition.
template<ePIXEL_FORMAT FU>
Pixel &	operator-= (Pixel< FU > const &p_px)
	Opérateur d'affectation par soustraction.
template<typename U >
Pixel &	operator-= (U const &p_t)
	Opérateur d'affectation par soustraction.
template<ePIXEL_FORMAT FU>
Pixel &	operator*= (Pixel< FU > const &p_px)
	Opérateur d'affectation par multiplication.
template<typename U >
Pixel &	operator*= (U const &p_t)
	Opérateur d'affectation par multiplication.
template<ePIXEL_FORMAT FU>
Pixel &	operator/= (Pixel< FU > const &p_px)
	Opérateur d'affectation par division.
template<typename U >
Pixel &	operator/= (U const &p_t)
	Opérateur d'affectation par division.
Pixel &	operator>> (std::size_t p_t)
	Opérateur de décalage binaire à droite.
void	clear ()
	Désalloue les composantes de ce pixel.
template<typename U >
void	sum (U &p_uResult) const
	Calcule la somme de toutes les composantes.
template<ePIXEL_FORMAT FU>
Pixel< FU >	mul (Pixel< FU > const &p_px) const
	Fonction de multiplication.
template<ePIXEL_FORMAT FU>
Pixel< FU >	mul (byte const &p_byVal) const
	Fonction de multiplication.
void	link (byte *p_pComponents)
	Lie les données de ce pixel à celles données en paramètre.
void	unlink ()
	Délie les données de ce pixel de celles données précédemment.
template<ePIXEL_FORMAT FU>
void	set (array< byte, pixel_definitions< FU >::size > const &p_components)
	Convertit les données et les copie dans les composantes de ce pixel.
template<ePIXEL_FORMAT FU>
void	set (byte const *p_components)
	Convertit les données et les copie dans les composantes de ce pixel.
template<ePIXEL_FORMAT FU>
void	set (Pixel< FU > const &p_px)
	Convertit le pixel et le copie dans les composantes de ce pixel.
component_ref	operator[] (std::size_t p_uiIndex)
	Récupère la donnée à l'index donné.
component_const_ref	operator[] (std::size_t p_uiIndex) const
	Récupère la donnée à l'index donné.
component_const_ptr	const_ptr () const
	Récupère le pointeur sur les données constantes.
component_ptr	ptr ()
	Récupère le pointeur sur les données.
iterator	begin ()
	Récupère un itérateur sur le premier élément.
const_iterator	begin () const
	Récupère un itérateur constant sur le premier élément.
const_iterator	end () const
	Récupère un itérateur constant sur le dernier élément.
Fonctions membres publiques statiques
static ePIXEL_FORMAT	format ()
	Récupère le format du pixel.

---

Description détaillée

template<ePIXEL_FORMAT FT>
class Castor::Pixel< FT >

Définition d'un pixel.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

29/08/2011

Remarques:

L'argument template ePIXEL_FORMAT sert a déterminer la taille et le format du pixel

---

Documentation des définitions de type membres

template<ePIXEL_FORMAT FT>

typedef byte const* Castor::Pixel< FT >::const_iterator

Typedef d'un pointeur constant sur un byte.

template<ePIXEL_FORMAT FT>

typedef byte* Castor::Pixel< FT >::iterator

Typedef d'un pointeur sur un byte.

---

Documentation des constructeurs et destructeur

template<ePIXEL_FORMAT FT>

Castor::Pixel< FT >::Pixel

(

bool

p_bInit = false

)

Constructeur.

Paramètres:

[in]

p_bInit

Dit si on initialise les données

template<ePIXEL_FORMAT FT>

Castor::Pixel< FT >::Pixel

(

byte *

p_components

)

Constructeur.

Remarques:

Le Pixel ne gère pas ses données

Paramètres:

[in]

p_components

Initialise les données à celles-ci

template<ePIXEL_FORMAT FT>

Castor::Pixel< FT >::Pixel

(

Pixel< FT > const &

p_pxl

)

Constructeur par copie.

Paramètres:

[in]

p_pxl

L'objet Pixel à copier

template<ePIXEL_FORMAT FT>

Castor::Pixel< FT >::Pixel

(

Pixel< FT > &&

p_pxl

)

Constructeur par déplacement.

Paramètres:

[in]

p_pxl

L'objet Pixel à déplacer

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Castor::Pixel< FT >::Pixel

(

array< byte, pixel_definitions< FU >::size > const &

p_components

)

Constructeur.

Remarques:

Le Pixel gère ses données

Paramètres:

[in]

p_components

Initialise les données à celles-ci

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Castor::Pixel< FT >::Pixel

(

Pixel< FU > const &

p_pxl

)

Constructeur.

Paramètres:

[in]

p_pxl

L'objet Pixel à copier

template<ePIXEL_FORMAT FT>

virtual Castor::Pixel< FT >::~Pixel

(

)

[virtual]

Destructeur.

---

Documentation des fonctions membres

template<ePIXEL_FORMAT FT>

iterator Castor::Pixel< FT >::begin

(

)

[inline]

Récupère un itérateur sur le premier élément.

Renvoie:

L'itérateur

template<ePIXEL_FORMAT FT>

const_iterator Castor::Pixel< FT >::begin

(

)

const [inline]

Récupère un itérateur constant sur le premier élément.

Renvoie:

L'itérateur

template<ePIXEL_FORMAT FT>

void Castor::Pixel< FT >::clear

(

)

Désalloue les composantes de ce pixel.

template<ePIXEL_FORMAT FT>

component_const_ptr Castor::Pixel< FT >::const_ptr

(

)

const [inline]

Récupère le pointeur sur les données constantes.

Renvoie:

Les données

template<ePIXEL_FORMAT FT>

const_iterator Castor::Pixel< FT >::end

(

)

const [inline]

Récupère un itérateur constant sur le dernier élément.

Renvoie:

L'itérateur

template<ePIXEL_FORMAT FT>

static ePIXEL_FORMAT Castor::Pixel< FT >::format

(

)

[inline, static]

Récupère le format du pixel.

Renvoie:

Le format du pixel

template<ePIXEL_FORMAT FT>

void Castor::Pixel< FT >::link

(

byte *

p_pComponents

)

Lie les données de ce pixel à celles données en paramètre.

Remarques:

Le pixel perd la maîtrise de ses données

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel< FU > Castor::Pixel< FT >::mul

(

byte const &

p_byVal

)

const

Fonction de multiplication.

Paramètres:

[in]

p_byVal

The value

Renvoie:

Le résultat de la multiplication

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel< FU > Castor::Pixel< FT >::mul

(

Pixel< FU > const &

p_px

)

const

Fonction de multiplication.

Paramètres:

[in]

p_px

Le pixel à multiplier

Renvoie:

Le résultat de la multiplication

template<ePIXEL_FORMAT FT>

template<typename U >

Pixel& Castor::Pixel< FT >::operator*=

(

U const &

p_t

)

Opérateur d'affectation par multiplication.

Paramètres:

[in]

p_t

La valeur à multiplier

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel& Castor::Pixel< FT >::operator*=

(

Pixel< FU > const &

p_px

)

Opérateur d'affectation par multiplication.

Paramètres:

[in]

p_px

L'objet Pixel à multiplier

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel& Castor::Pixel< FT >::operator+=

(

Pixel< FU > const &

p_px

)

Opérateur d'affectation par addition.

Paramètres:

[in]

p_px

L'objet Pixel à additionner

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<typename U >

Pixel& Castor::Pixel< FT >::operator+=

(

U const &

p_t

)

Opérateur d'affectation par addition.

Paramètres:

[in]

p_t

La valeur à additionner

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel& Castor::Pixel< FT >::operator-=

(

Pixel< FU > const &

p_px

)

Opérateur d'affectation par soustraction.

Paramètres:

[in]

p_px

L'objet Pixel à soustraire

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<typename U >

Pixel& Castor::Pixel< FT >::operator-=

(

U const &

p_t

)

Opérateur d'affectation par soustraction.

Paramètres:

[in]

p_t

La valeur à soustraire

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel& Castor::Pixel< FT >::operator/=

(

Pixel< FU > const &

p_px

)

Opérateur d'affectation par division.

Paramètres:

[in]

p_px

L'objet Pixel à diviser

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<typename U >

Pixel& Castor::Pixel< FT >::operator/=

(

U const &

p_t

)

Opérateur d'affectation par division.

Paramètres:

[in]

p_t

La valeur à diviser

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

Pixel& Castor::Pixel< FT >::operator=

(

Pixel< FT > const &

p_pxl

)

Opérateur d'affectation par déplacement.

Paramètres:

[in]

p_pxl

L'objet Pixel à déplacer

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

Pixel& Castor::Pixel< FT >::operator=

(

Pixel< FT > &&

p_pxl

)

Opérateur d'affectation par copie.

Paramètres:

[in]

p_pxl

L'objet Pixel à copier

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

Pixel& Castor::Pixel< FT >::operator=

(

Pixel< FU > const &

p_pxl

)

Opérateur d'affectation par copie.

Paramètres:

[in]

p_pxl

L'objet Pixel à copier

Renvoie:

Une référence sur cet objet Pixel

template<ePIXEL_FORMAT FT>

Pixel& Castor::Pixel< FT >::operator>>

(

std::size_t

p_t

)

Opérateur de décalage binaire à droite.

Paramètres:

[in]

p_t

L'offset de décalage

Renvoie:

Une référence sur ce pixel

template<ePIXEL_FORMAT FT>

component_ref Castor::Pixel< FT >::operator[]

(

std::size_t

p_uiIndex

)

[inline]

Récupère la donnée à l'index donné.

Remarques:

Aucun check n'est fait, s'il y a une erreur d'index, attendez-vous à un crash

Renvoie:

Une référence sur la donnée à l'index voulu

template<ePIXEL_FORMAT FT>

component_const_ref Castor::Pixel< FT >::operator[]

(

std::size_t

p_uiIndex

)

const [inline]

Récupère la donnée à l'index donné.

Remarques:

Aucun check n'est fait, s'il y a une erreur d'index, attendez-vous à un crash

Renvoie:

Une référence constante sur la donnée à l'index voulu

template<ePIXEL_FORMAT FT>

component_ptr Castor::Pixel< FT >::ptr

(

)

[inline]

Récupère le pointeur sur les données.

Renvoie:

Les données

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

void Castor::Pixel< FT >::set

(

byte const *

p_components

)

Convertit les données et les copie dans les composantes de ce pixel.

Paramètres:

[in]

p_components

Les données à convertir

Renvoie:

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

void Castor::Pixel< FT >::set

(

array< byte, pixel_definitions< FU >::size > const &

p_components

)

Convertit les données et les copie dans les composantes de ce pixel.

Paramètres:

[in]

p_components

Les données à convertir

Renvoie:

template<ePIXEL_FORMAT FT>

template<ePIXEL_FORMAT FU>

void Castor::Pixel< FT >::set

(

Pixel< FU > const &

p_px

)

Convertit le pixel et le copie dans les composantes de ce pixel.

Paramètres:

[in]

p_px

Le pixel à convertir

Renvoie:

template<ePIXEL_FORMAT FT>

template<typename U >

void Castor::Pixel< FT >::sum

(

U &

p_uResult

)

const

Calcule la somme de toutes les composantes.

Paramètres:

[out]

p_uResult

Reçoit la somme

template<ePIXEL_FORMAT FT>

void Castor::Pixel< FT >::unlink

(

)

Délie les données de ce pixel de celles données précédemment.

Remarques:

Le pixel regagne la maîtrise de ses données

---

La documentation de cette classe a été générée à partir du fichier suivant :

• include/CastorUtils/Pixel.hpp