Référence de la classe Castor::PxBufferBase

Définition de la classe de base d'un buffer de Pixel. Plus de détails...

Graphe d'héritage de Castor::PxBufferBase:

Graphe de collaboration de Castor::PxBufferBase:

Liste de tous les membres

Types publics
typedef byte *	iterator
	Typedef d'un pointeur sur byte.
typedef byte const *	const_iterator
	Typedef d'un pointeur constant sur byte.
Fonctions membres publiques
	PxBufferBase (Size const &p_size, ePIXEL_FORMAT p_ePixelFormat, byte const *p_pBuffer=NULL, ePIXEL_FORMAT p_eBufferFormat=ePIXEL_FORMAT_A8R8G8B8)
	Constructeur à partir d'un autre buffer.
	PxBufferBase (PxBufferBase const &p_pixelBuffer)
	Constructeur par copie.
	PxBufferBase (PxBufferBase &&p_pixelBuffer)
	Constructeur par déplacement.
virtual	~PxBufferBase ()
	Destructeur.
PxBufferBase &	operator= (PxBufferBase const &p_pixelBuffer)
	Opérateur d'affectation par copie.
PxBufferBase &	operator= (PxBufferBase &&p_pixelBuffer)
	Opérateur d'affectation par déplacement.
virtual void	clear ()
	Détruit le buffer de données.
virtual void	init (byte const *p_pBuffer, ePIXEL_FORMAT p_eBufferFormat)
	Initialise le buffer de données à celui donné.
virtual void	init (Size const &p_size)
	Initialise le buffer de données à la taille donnée.
virtual void	swap (PxBufferBase &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)=0
	Convertit et assigne les données du buffer donné à ce buffer.
virtual byte const *	const_ptr () const =0
	Récupère le pointeur sur les données constantes.
virtual byte *	ptr ()=0
	Récupère le pointeur sur les données.
virtual std::size_t	size () const =0
	Récupère la taille totale du buffer.
virtual std::shared_ptr < PxBufferBase >	clone () const =0
	Crée un nouveau buffer avec les mêmes valeurs.
virtual byte *	get_at (std::size_t x, std::size_t y)=0
	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 =0
	Récupère les données du pixel à la position donnée.
virtual void	flip ()=0
	Effectue un échange vertical des pixels.
virtual void	mirror ()=0
	Effectue un échange horizontal des pixels.
ePIXEL_FORMAT	format () const
	Récupère le format ds pixels.
unsigned int	width () const
	Récupère la largeur du buffer.
unsigned int	height () const
	Récupère la hauteur du buffer.
Size const &	dimensions () const
	Récupère les dimensions du buffer.
std::size_t	count () const
	Récupère le compte des pixels.
byte *	get_at (Position const &p_position)
	Récupère les données du pixel à la position donnée.
byte const *	get_at (Position const &p_position) const
	Récupère les données du pixel à la position donnée.
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 PxBufferBase *	create (Size const &p_size, ePIXEL_FORMAT p_eWantedFormat, byte const *p_pBuffer=NULL, ePIXEL_FORMAT p_eBufferFormat=ePIXEL_FORMAT_A8R8G8B8)
	Crée un buffer avec les données voulues.
Attributs protégés
Size	m_size
	Dimensions du buffer.
byte *	m_pBuffer
	Données du buffer.

---

Description détaillée

Définition de la classe de base d'un buffer de Pixel.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

29/08/2011

Remarques:

Il a 2 dimensions

---

Documentation des définitions de type membres

typedef byte const* Castor::PxBufferBase::const_iterator

Typedef d'un pointeur constant sur byte.

typedef byte* Castor::PxBufferBase::iterator

Typedef d'un pointeur sur byte.

---

Documentation des constructeurs et destructeur

Castor::PxBufferBase::PxBufferBase	(	Size const &	p_size,
		ePIXEL_FORMAT	p_ePixelFormat,
		byte const *	p_pBuffer = NULL,
		ePIXEL_FORMAT	p_eBufferFormat = ePIXEL_FORMAT_A8R8G8B8
	)

Constructeur à partir d'un autre buffer.

Paramètres:

[in]	p_size	Dimensions du buffer
[in]	p_ePixelFormat	Format des pixels du buffer
[in]	p_pBuffer	Buffer de données
[in]	p_eBufferFormat	Format des pixels du buffer de données

Castor::PxBufferBase::PxBufferBase

(

PxBufferBase const &

p_pixelBuffer

)

Constructeur par copie.

Paramètres:

[in]

p_pixelBuffer

L'objet PxBufferBase à copier

Castor::PxBufferBase::PxBufferBase

(

PxBufferBase &&

p_pixelBuffer

)

Constructeur par déplacement.

Paramètres:

[in]

p_pixelBuffer

L'objet PxBufferBase à déplacer

virtual Castor::PxBufferBase::~PxBufferBase

(

)

[virtual]

Destructeur.

---

Documentation des fonctions membres

virtual void Castor::PxBufferBase::assign	(	std::vector< byte > const &	p_pBuffer,
		ePIXEL_FORMAT	p_eBufferFormat
	)			[pure 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émenté dans Castor::PxBuffer< PF >.

iterator Castor::PxBufferBase::begin

(

)

[inline]

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

Renvoie:

L'itérateur

const_iterator Castor::PxBufferBase::begin

(

)

const [inline]

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

Renvoie:

L'itérateur

virtual void Castor::PxBufferBase::clear

(

)

[virtual]

Détruit le buffer de données.

virtual std::shared_ptr<PxBufferBase> Castor::PxBufferBase::clone

(

)

const [pure virtual]

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

Renvoie:

Le buffer créé

Implémenté dans Castor::PxBuffer< PF >.

virtual byte const* Castor::PxBufferBase::const_ptr

(

)

const [pure virtual]

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

Renvoie:

Les données

Implémenté dans Castor::PxBuffer< PF >.

std::size_t Castor::PxBufferBase::count

(

)

const [inline]

Récupère le compte des pixels.

Renvoie:

largeur * hauteur

Voici le graphe d'appel pour cette fonction :

static PxBufferBase* Castor::PxBufferBase::create	(	Size const &	p_size,
		ePIXEL_FORMAT	p_eWantedFormat,
		byte const *	p_pBuffer = NULL,
		ePIXEL_FORMAT	p_eBufferFormat = ePIXEL_FORMAT_A8R8G8B8
	)			[static]

Crée un buffer avec les données voulues.

Paramètres:

[in]	p_size	Dimensions du buffer
[in]	p_eWantedFormat	Format des pixels du buffer
[in]	p_pBuffer	Buffer de données
[in]	p_eBufferFormat	Format des pixels du buffer de données

Renvoie:

Le buffer créé

Size const& Castor::PxBufferBase::dimensions

(

)

const [inline]

Récupère les dimensions du buffer.

Renvoie:

Les dimensions du buffer

const_iterator Castor::PxBufferBase::end

(

)

const [inline]

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

Renvoie:

L'itérateur

Voici le graphe d'appel pour cette fonction :

virtual void Castor::PxBufferBase::flip

(

)

[pure virtual]

Effectue un échange vertical des pixels.

Implémenté dans Castor::PxBuffer< PF >.

ePIXEL_FORMAT Castor::PxBufferBase::format

(

)

const [inline]

Récupère le format ds pixels.

Renvoie:

Le format des pixels

byte const* Castor::PxBufferBase::get_at

(

Position const &

p_position

)

const [inline]

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

Paramètres:

[in]

p_position

The pixel position

Renvoie:

Les données constantes du pixel

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

byte* Castor::PxBufferBase::get_at

(

Position const &

p_position

)

[inline]

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

Paramètres:

[in]

p_position

The pixel position

Renvoie:

Les données du pixel

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

virtual byte const* Castor::PxBufferBase::get_at	(	std::size_t	x,
		std::size_t	y
	)			const [pure 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émenté dans Castor::PxBuffer< PF >.

virtual byte* Castor::PxBufferBase::get_at	(	std::size_t	x,
		std::size_t	y
	)			[pure 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émenté dans Castor::PxBuffer< PF >.

unsigned int Castor::PxBufferBase::height

(

)

const [inline]

Récupère la hauteur du buffer.

Renvoie:

La hauteur du buffer

virtual void Castor::PxBufferBase::init	(	byte const *	p_pBuffer,
		ePIXEL_FORMAT	p_eBufferFormat
	)			[virtual]

Initialise le buffer de données à celui donné.

Remarques:

Des conversions sont faites si besoin est

Paramètres:

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

virtual void Castor::PxBufferBase::init

(

Size const &

p_size

)

[virtual]

Initialise le buffer de données à la taille donnée.

Remarques:

Des conversions sont faites si besoin est

Paramètres:

[in]

p_size

Les dimensions du buffer

virtual void Castor::PxBufferBase::mirror

(

)

[pure virtual]

Effectue un échange horizontal des pixels.

Implémenté dans Castor::PxBuffer< PF >.

PxBufferBase& Castor::PxBufferBase::operator=

(

PxBufferBase &&

p_pixelBuffer

)

Opérateur d'affectation par déplacement.

Paramètres:

[in]

p_pixelBuffer

L'objet PxBufferBase à déplacer

Renvoie:

Une référence sur cet objet PxBufferBase

PxBufferBase& Castor::PxBufferBase::operator=

(

PxBufferBase const &

p_pixelBuffer

)

Opérateur d'affectation par copie.

Paramètres:

[in]

p_pixelBuffer

L'objet PxBufferBase à copier

Renvoie:

Une référence sur cet objet PxBufferBase

virtual byte* Castor::PxBufferBase::ptr

(

)

[pure virtual]

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

Renvoie:

Les données

Implémenté dans Castor::PxBuffer< PF >.

virtual std::size_t Castor::PxBufferBase::size

(

)

const [pure virtual]

Récupère la taille totale du buffer.

Renvoie:

count() * (size of a pixel)

Implémenté dans Castor::PxBuffer< PF >.

Voici le graphe d'appel pour cette fonction :

virtual void Castor::PxBufferBase::swap

(

PxBufferBase &

p_pixelBuffer

)

[virtual]

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

Paramètres:

[in]

p_pixelBuffer

Le buffer à échanger

unsigned int Castor::PxBufferBase::width

(

)

const [inline]

Récupère la largeur du buffer.

Renvoie:

La largeur du buffer

---

Documentation des données membres

byte* Castor::PxBufferBase::m_pBuffer [protected]

Données du buffer.

Size Castor::PxBufferBase::m_size [protected]

Dimensions du buffer.

---

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

• include/CastorUtils/Pixel.hpp