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

Ressource Image. Plus de détails...

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

Graphe de collaboration de Castor::Image:

Liste de tous les membres

Fonctions membres publiques
	Image (String const &p_strName)
	Constructeur.
	Image (Image const &p_image)
	Constructeur par copie.
	Image (Image &&p_image)
	Constructeur par déplacement.
Image &	operator= (Image const &p_image)
	Opérateur d'affectation par copie.
Image &	operator= (Image &&p_image)
	Opérateur d'affectation par déplacement.
virtual	~Image ()
	Destructeur.
Image &	Fill (Colour const &p_clrColour)
	Remplit tous les pixels de l'image avec la couleur donnée.
Image &	SetPixel (std::size_t x, std::size_t y, unsigned char const *p_pPixel)
	Remplit le pixel demandé avec le buffer donné.
Image &	SetPixel (std::size_t x, std::size_t y, Colour const &p_clrColour)
	Définit la couleur du pixel demandé.
template<ePIXEL_FORMAT PF>
Image &	SetPixel (std::size_t x, std::size_t y, Pixel< PF > const &p_pixel)
	Définit le pixel demandé avec le pixel donné.
template<ePIXEL_FORMAT PF>
void	GetPixel (std::size_t x, std::size_t y, Pixel< PF > &p_pixel) const
	Récupère le pixel aux coordonnées données.
void	GetPixel (std::size_t x, std::size_t y, unsigned char *p_pPixel, ePIXEL_FORMAT p_eFormat) const
	Récupère le pixel demandé et remplit le buffer au format donné.
Colour	GetPixel (std::size_t x, std::size_t y) const
	Récupère la couleur du pixel demandé.
Image &	CopyImage (Image const &p_src)
	Copie l'image donnée dans celle-ci.
Image	SubImage (Rectangle const &p_rcRect) const
	Retourne la portion d'image contenue dans le rectangle donné.
Image &	Flip ()
	Retourne verticalement l'image.
Image &	Mirror ()
	Retourne horizontalement l'image.
Image &	Initialise (Size const &p_ptSize, ePIXEL_FORMAT p_ePixelFormat, std::vector< byte > const &p_pBuffer, ePIXEL_FORMAT p_eBufferFormat, Path const &p_path=cuEmptyString)
	Initialise l'image avec les paramètres donnés.
Image &	Initialise (Size const &p_ptSize, ePIXEL_FORMAT p_ePixelFormat=ePIXEL_FORMAT_A8R8G8B8, byte const *p_pBuffer=NULL, ePIXEL_FORMAT p_eBufferFormat=ePIXEL_FORMAT_A8R8G8B8, Path const &p_path=cuEmptyString)
	Initialise l'image avec les paramètres donnés.
Image &	Initialise (Size const &p_ptSize, PxBufferBase const &p_pBuffer, Path const &p_path=cuEmptyString)
	Initialise l'image avec les paramètres donnés.
template<ePIXEL_FORMAT PFSrc, ePIXEL_FORMAT PFDst>
void	Initialise (Size const &p_ptSize, byte const *p_pBuffer=NULL, Path const &p_path=cuEmptyString)
	Initialise l'image avec les paramètres donnés.
Size const &	GetDimensions () const
	Récupère les dimensions de l'image.
std::size_t	GetSize () const
	Récupère la taille des données de l'image.
unsigned int	GetWidth () const
	Récupère la largeur de l'image.
unsigned int	GetHeight () const
	Récupère la hauteur de l'image.
Path	GetPath () const
	Récupère le chemin du fichier de l'image.
byte *	GetBuffer ()
	Récupère les données de l'image.
byte const *	GetBuffer () const
	Récupère les données de l'image.
ePIXEL_FORMAT	GetPixelFormat () const
	Récupère le format des pixels de l'image.
Amis
class	Font

---

Description détaillée

Ressource Image.

Auteur:

Sylvain DOREMUS

Date:

14/02/2010

---

Documentation des constructeurs et destructeur

Castor::Image::Image

(

String const &

p_strName

)

Constructeur.

Paramètres:

[in]

p_strName

Le nom de ressource

Castor::Image::Image

(

Image const &

p_image

)

Constructeur par copie.

Paramètres:

[in]

p_image

L'objet Image à copier

Castor::Image::Image

(

Image &&

p_image

)

Constructeur par déplacement.

Paramètres:

[in]

p_image

L'objet Image à déplacer

virtual Castor::Image::~Image

(

)

[virtual]

Destructeur.

---

Documentation des fonctions membres

Image& Castor::Image::CopyImage

(

Image const &

p_src

)

Copie l'image donnée dans celle-ci.

Paramètres:

[in]

p_src

L'image à copier

Renvoie:

La référence de l'image

Image& Castor::Image::Fill

(

Colour const &

p_clrColour

)

Remplit tous les pixels de l'image avec la couleur donnée.

Paramètres:

[in]

p_clrColour

La couleur de remplissage

Renvoie:

La référence de l'image

Image& Castor::Image::Flip

(

)

Retourne verticalement l'image.

Renvoie:

La référence de l'image

byte* Castor::Image::GetBuffer

(

)

[inline]

Récupère les données de l'image.

Renvoie:

Les données de l'image

byte const* Castor::Image::GetBuffer

(

)

const [inline]

Récupère les données de l'image.

Renvoie:

Les données de l'image

Size const& Castor::Image::GetDimensions

(

)

const [inline]

Récupère les dimensions de l'image.

Renvoie:

Les dimensions de l'image

unsigned int Castor::Image::GetHeight

(

)

const [inline]

Récupère la hauteur de l'image.

Renvoie:

La hauteur de l'image

Path Castor::Image::GetPath

(

)

const [inline]

Récupère le chemin du fichier de l'image.

Renvoie:

Le chemin du fichier de l'image

Colour Castor::Image::GetPixel	(	std::size_t	x,
		std::size_t	y
	)			const

Récupère la couleur du pixel demandé.

Paramètres:

[in]

x,y

Les coordonnées du pixel

Renvoie:

La couleur du pixel

void Castor::Image::GetPixel	(	std::size_t	x,
		std::size_t	y,
		unsigned char *	p_pPixel,
		ePIXEL_FORMAT	p_eFormat
	)			const

Récupère le pixel demandé et remplit le buffer au format donné.

Paramètres:

[in]	x,y	Les coordonnées du pixel
[out]	p_pPixel	Reçoit le pixel dans le format donné
[in]	p_eFormat	Le format voulu pour le buffer

template<ePIXEL_FORMAT PF>

void Castor::Image::GetPixel	(	std::size_t	x,
		std::size_t	y,
		Pixel< PF > &	p_pixel
	)			const [inline]

Récupère le pixel aux coordonnées données.

Paramètres:

[in]	x,y	Les coordonnées du pixel
[out]	p_pixel	Reçoit le pixel

ePIXEL_FORMAT Castor::Image::GetPixelFormat

(

)

const [inline]

Récupère le format des pixels de l'image.

Renvoie:

Le format des pixels de l'image

std::size_t Castor::Image::GetSize

(

)

const [inline]

Récupère la taille des données de l'image.

Renvoie:

La taille des données de l'image

unsigned int Castor::Image::GetWidth

(

)

const [inline]

Récupère la largeur de l'image.

Renvoie:

La largeur de l'image

Image& Castor::Image::Initialise	(	Size const &	p_ptSize,
		PxBufferBase const &	p_pBuffer,
		Path const &	p_path = cuEmptyString
	)

Initialise l'image avec les paramètres donnés.

Paramètres:

[in]	p_ptSize	Les dimensions voulues pour l'image
[in]	p_pBuffer	Un buffer de pixels
[in]	p_path	Le chemin du fichier contenant l'image

Renvoie:

La référence de l'image

template<ePIXEL_FORMAT PFSrc, ePIXEL_FORMAT PFDst>

void Castor::Image::Initialise	(	Size const &	p_ptSize,
		byte const *	p_pBuffer = NULL,
		Path const &	p_path = cuEmptyString
	)			[inline]

Initialise l'image avec les paramètres donnés.

Remarques:

Le format voulu ainsi que le format du buffer sont les arguments template

Paramètres:

[in]	p_ptSize	Les dimensions voulues pour l'image
[in]	p_pBuffer	Un buffer de pixels
[in]	p_path	Le chemin du fichier contenant l'image

Renvoie:

La référence de l'image

Image& Castor::Image::Initialise	(	Size const &	p_ptSize,
		ePIXEL_FORMAT	p_ePixelFormat,
		std::vector< byte > const &	p_pBuffer,
		ePIXEL_FORMAT	p_eBufferFormat,
		Path const &	p_path = cuEmptyString
	)

Initialise l'image avec les paramètres donnés.

Paramètres:

[in]	p_ptSize	Les dimensions voulues pour l'image
[in]	p_ePixelFormat	Le format de pixel voulu pour l'image
[in]	p_pBuffer	Un buffer de pixels
[in]	p_eBufferFormat	Le format des pixels du buffer
[in]	p_path	Le chemin du fichier contenant l'image

Renvoie:

La référence de l'image

Image& Castor::Image::Initialise	(	Size const &	p_ptSize,
		ePIXEL_FORMAT	p_ePixelFormat = ePIXEL_FORMAT_A8R8G8B8,
		byte const *	p_pBuffer = NULL,
		ePIXEL_FORMAT	p_eBufferFormat = ePIXEL_FORMAT_A8R8G8B8,
		Path const &	p_path = cuEmptyString
	)

Initialise l'image avec les paramètres donnés.

Paramètres:

[in]	p_ptSize	Les dimensions voulues pour l'image
[in]	p_ePixelFormat	Le format de pixel voulu pour l'image
[in]	p_pBuffer	Un buffer de pixels
[in]	p_eBufferFormat	Le format des pixels du buffer
[in]	p_path	Le chemin du fichier contenant l'image

Renvoie:

La référence de l'image

Image& Castor::Image::Mirror

(

)

Retourne horizontalement l'image.

Renvoie:

La référence de l'image

Image& Castor::Image::operator=

(

Image &&

p_image

)

Opérateur d'affectation par déplacement.

Paramètres:

[in]

p_image

L'objet Image à déplacer

Renvoie:

Une référence sur cet objet Image

Image& Castor::Image::operator=

(

Image const &

p_image

)

Opérateur d'affectation par copie.

Paramètres:

[in]

p_image

L'objet Image à copier

Renvoie:

Une référence sur cet objet Image

Image& Castor::Image::SetPixel	(	std::size_t	x,
		std::size_t	y,
		Colour const &	p_clrColour
	)

Définit la couleur du pixel demandé.

Paramètres:

[in]	x,y	Les coordonnées du pixel
[in]	p_clrColour	La couleur

Renvoie:

La référence de l'image

template<ePIXEL_FORMAT PF>

Image& Castor::Image::SetPixel	(	std::size_t	x,
		std::size_t	y,
		Pixel< PF > const &	p_pixel
	)			[inline]

Définit le pixel demandé avec le pixel donné.

Paramètres:

[in]	x,y	Les coordonnées du pixel
[in]	p_pixel	Le pixel

Renvoie:

La référence de l'image

Image& Castor::Image::SetPixel	(	std::size_t	x,
		std::size_t	y,
		unsigned char const *	p_pPixel
	)

Remplit le pixel demandé avec le buffer donné.

Paramètres:

[in]	x,y	Les coordonnées du pixel
[in]	p_pPixel	Le buffer

Renvoie:

La référence de l'image

Image Castor::Image::SubImage

(

Rectangle const &

p_rcRect

)

const

Retourne la portion d'image contenue dans le rectangle donné.

Paramètres:

[in]

p_rcRect

Le rectangle de la portion d'image

Renvoie:

La portion d'image

---

Documentation des fonctions amies et associées

friend class Font [friend]

---

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

• include/CastorUtils/Image.hpp