Buffer de pixels avec le format de pixel en argument template. Plus de détails...

Graphe d'héritage de Castor::PxBuffer< PF >:

Graphe de collaboration de Castor::PxBuffer< PF >:

Types publics
typedef Pixel< PF >	pixel
	Typedef sur un Pixel.
typedef DynPoint< pixel >	column
	Typedef sur un DynPoint de pixel.
Fonctions membres publiques
	PxBuffer (Size const &p_ptSize, byte const *p_pBuffer=NULL, ePIXEL_FORMAT p_eBufferFormat=ePIXEL_FORMAT_A8R8G8B8)
	Constructeur.
	PxBuffer (PxBuffer const &p_pixelBuffer)
	Constructeur par copie.
	PxBuffer (PxBuffer &&p_pixelBuffer)
	Constructeur par déplacement.
virtual	~PxBuffer ()
	Destructeur.
PxBuffer &	operator= (PxBuffer const &p_pixelBuffer)
	Opérateur d'affectation par copie.
PxBuffer &	operator= (PxBuffer &&p_pixelBuffer)
	Opérateur d'affectation par déplacement.
column const &	operator[] (std::size_t p_uiIndex) const
	Récupère la colonne à l'index donné.
column &	operator[] (std::size_t p_uiIndex)
	Récupère la colonne à l'index donné.
virtual void	swap (PxBuffer &p_pixelBuffer)
	Echange les données de ce buffer avec celles du buffer donné.
virtual void	assign (std::vector< byte > const &p_pBuffer, ePIXEL_FORMAT p_eBufferFormat)
	Convertit et assigne les données du buffer donné à ce buffer.
virtual byte const *	const_ptr () const
	Récupère le pointeur sur les données constantes.
virtual byte *	ptr ()
	Récupère le pointeur sur les données.
virtual std::size_t	size () const
	Récupère la taille totale du buffer.
virtual std::shared_ptr < PxBufferBase >	clone () const
	Crée un nouveau buffer avec les mêmes valeurs.
virtual byte *	get_at (std::size_t x, std::size_t y)
	Récupère les données du pixel à la position donnée.
virtual byte const *	get_at (std::size_t x, std::size_t y) const
	Récupère les données du pixel à la position donnée.
virtual void	flip ()
	Effectue un échange vertical des pixels.
virtual void	mirror ()
	Effectue un échange horizontal des pixels.

Description détaillée

template<ePIXEL_FORMAT PF>
class Castor::PxBuffer< PF >

Buffer de pixels avec le format de pixel en argument template.

Auteur:: Sylvain DOREMUS

Version:: 0.6.1.0

Date:: 19/10/2011

Documentation des définitions de type membres

template<ePIXEL_FORMAT PF>

typedef DynPoint<pixel> Castor::PxBuffer< PF >::column

Typedef sur un DynPoint de pixel.

template<ePIXEL_FORMAT PF>

typedef Pixel<PF> Castor::PxBuffer< PF >::pixel

Typedef sur un Pixel.

Documentation des constructeurs et destructeur

template<ePIXEL_FORMAT PF>

Castor::PxBuffer< PF >::PxBuffer	(	Size const &	p_ptSize,
		byte const *	p_pBuffer = `NULL`,
		ePIXEL_FORMAT	p_eBufferFormat = `ePIXEL_FORMAT_A8R8G8B8`
	)

Constructeur.

Paramètres:

`[in]`	p_ptSize	Les dimensions voulues pour le buffer
`[in]`	p_pBuffer	Buffer de données
`[in]`	p_eBufferFormat	Format des pixels du buffer de données

template<ePIXEL_FORMAT PF>

Castor::PxBuffer< PF >::PxBuffer ( PxBuffer< PF > const & p_pixelBuffer )

Constructeur par copie.

Paramètres:

[in] p_pixelBuffer L'objet PxBuffer à copier

template<ePIXEL_FORMAT PF>

Castor::PxBuffer< PF >::PxBuffer ( PxBuffer< PF > && p_pixelBuffer )

Constructeur par déplacement.

Paramètres:

[in] p_pixelBuffer L'objet PxBuffer à déplacer

template<ePIXEL_FORMAT PF>

virtual Castor::PxBuffer< PF >::~PxBuffer ( ) [virtual]

Destructeur.

Documentation des fonctions membres

template<ePIXEL_FORMAT PF>

virtual void Castor::PxBuffer< PF >::assign	(	std::vector< byte > const &	p_pBuffer,
		ePIXEL_FORMAT	p_eBufferFormat
	)			`[virtual]`

Convertit et assigne les données du buffer donné à ce buffer.

Paramètres:

`[in]`	p_pBuffer	Buffer de données
`[in]`	p_eBufferFormat	Format des pixels du buffer de données

Renvoie:

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual std::shared_ptr< PxBufferBase > Castor::PxBuffer< PF >::clone ( ) const [virtual]

Crée un nouveau buffer avec les mêmes valeurs.

Renvoie:: Le buffer créé

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual byte const* Castor::PxBuffer< PF >::const_ptr ( ) const [inline, virtual]

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

Renvoie:: Les données

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual void Castor::PxBuffer< PF >::flip ( ) [virtual]

Effectue un échange vertical des pixels.

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual byte* Castor::PxBuffer< PF >::get_at	(	std::size_t	x,
		std::size_t	y
	)			`[virtual]`

Récupère les données du pixel à la position donnée.

Paramètres:

[in] x,y The pixel position

Renvoie:: Les données du pixel

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual byte const* Castor::PxBuffer< PF >::get_at	(	std::size_t	x,
		std::size_t	y
	)			const `[virtual]`

Récupère les données du pixel à la position donnée.

Paramètres:

[in] x,y The pixel position

Renvoie:: Les données constantes du pixel

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual void Castor::PxBuffer< PF >::mirror ( ) [virtual]

Effectue un échange horizontal des pixels.

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

PxBuffer& Castor::PxBuffer< PF >::operator= ( PxBuffer< PF > && p_pixelBuffer )

Opérateur d'affectation par déplacement.

Paramètres:

[in] p_pixelBuffer L'objet PxBuffer à déplacer

Renvoie:: Une référence sur cet objet PxBuffer

template<ePIXEL_FORMAT PF>

PxBuffer& Castor::PxBuffer< PF >::operator= ( PxBuffer< PF > const & p_pixelBuffer )

Opérateur d'affectation par copie.

Paramètres:

[in] p_pixelBuffer L'objet PxBuffer à copier

Renvoie:: Une référence sur cet objet PxBuffer

template<ePIXEL_FORMAT PF>

column& Castor::PxBuffer< PF >::operator[] ( std::size_t p_uiIndex ) [inline]

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

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

Paramètres:

[in] p_uiIndex L'index

Renvoie:: Une référence sur la colonne à l'index voulu

template<ePIXEL_FORMAT PF>

column const& Castor::PxBuffer< PF >::operator[] ( std::size_t p_uiIndex ) const [inline]

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

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

Paramètres:

[in] p_uiIndex L'index

Renvoie:: Une référence constante sur la colonne à l'index voulu

template<ePIXEL_FORMAT PF>

virtual byte* Castor::PxBuffer< PF >::ptr ( ) [inline, virtual]

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

Renvoie:: Les données

Implémente Castor::PxBufferBase.

template<ePIXEL_FORMAT PF>

virtual std::size_t Castor::PxBuffer< PF >::size ( ) const [inline, virtual]

Récupère la taille totale du buffer.

Renvoie:: count() * pixel_definitions< PF >::size

Implémente Castor::PxBufferBase.

Voici le graphe d'appel pour cette fonction :

template<ePIXEL_FORMAT PF>

virtual void Castor::PxBuffer< PF >::swap ( PxBuffer< PF > & p_pixelBuffer ) [virtual]

Echange les données de ce buffer avec celles du buffer donné.

Paramètres:

[in] p_pixelBuffer Le buffer à échanger

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

include/CastorUtils/Pixel.hpp

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

Types publics

Fonctions membres publiques

Description détaillée

template<ePIXEL_FORMAT PF> class Castor::PxBuffer< PF >

Documentation des définitions de type membres

Documentation des constructeurs et destructeur

Documentation des fonctions membres

template<ePIXEL_FORMAT PF>
class Castor::PxBuffer< PF >