Fonctions membres publiques

# Référence de la classe USpeedGameEngine::Image

Classe mère de traitement des images. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| Image ()
| Construteur par défaut.
| ~Image ()
| Destructeur par défaut.
bool | load (char *filename, USGE_Image type)
| Permet de lire l'image donnée et de le charger (Supprimer le fichier déjà chargé si c'est le cas).
bool | loadFromBuffer (unsigned char *data, unsigned long int bufferLength, USGE_Image type)
| Permet de lire l'image donnée et de le charger (Supprimer le fichier déjà chargé si c'est le cas).
bool | write (char *filename, USGE_Image type)
| Permet d'écrire l'image donnée dans un fichier JPEG.
bool | loadBox (unsigned long int width, unsigned long int height)
| Permet de charger un rectangle transparent de la taille donnée.
void | clear ()
| Permet d'effacer l'image stockée et de ré-initialiser les variables.
void | fill (unsigned long int arvb)
| Permet de remplir l'image existante avec la couleur spécifiées.
bool | copyFrom (int x, int y, Image *img)
| Copie l'image spécifiée sur l'image actuelle aux coordonnées spécifiées.
unsigned long int * | moveDatas ()
| Permet de déplacer (transfert) les données de l'image chargée vers le pointeur spécifié.
unsigned long int | getWidth ()
| Retourne la largeur actuelle de l'image.
unsigned long int | getHeight ()
| Retourne la hauteur actuelle de l'image.
unsigned long int * | getData ()
| Retourne les données de l'image actuelle.

## Description détaillée

Classe mère de traitement des images.

N.B. : cette classe ainsi que toutes les classes d'images (filles héritant de cette classe) n'autorisent pas le chargement d'images étant suppérieures à `512 x 512 px` pour la "PlayStation Portable" et `1024 x 1024 px` pour la version "Windows".

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Image::Image | ( |  | ) |

Construteur par défaut.

Auteur:
  U.Speed

Image::~Image | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

void Image::clear | ( |  | ) |

Permet d'effacer l'image stockée et de ré-initialiser les variables.

Auteur:
  U.Speed

bool Image::copyFrom | ( | int | x,
|  | int | y,
|  | Image * | img |
| ) |  |  |

Copie l'image spécifiée sur l'image actuelle aux coordonnées spécifiées.

Auteur:
  U.Speed

Paramètres:

  | x | int : position X de l'affichage (basé en 0)
  | y | int : position Y de l'affichage (basé en 0)
  | img | Image* : l'image source à copier

Renvoie:
  bool : l'état de la copie

void Image::fill | ( | unsigned long int | arvb | ) |

Permet de remplir l'image existante avec la couleur spécifiées.

Auteur:
  U.Speed

Paramètres:

  | arvb | unsigned long int : couleur de remplissage (alpha pris en compte) sous la forme 0xAARRGGBB
           0xAA...... : couche "alpha" (transparence : 255 = opaque)
           0x..RR.... : couche "rouge" (255 = rouge maximum)
           0x....GG.. : couche "verte" (255 = vert maximum)
           0x......BB : couche "bleue" (255 = bleu maximum)

unsigned long int * Image::getData | ( |  | ) |

Retourne les données de l'image actuelle.

Auteur:
  U.Speed

Renvoie:
  unsigned long int * : les données

unsigned long int Image::getHeight | ( |  | ) |

Retourne la hauteur actuelle de l'image.

Auteur:
  U.Speed

Renvoie:
  unsigned long int : la hauteur

unsigned long int Image::getWidth | ( |  | ) |

Retourne la largeur actuelle de l'image.

Auteur:
  U.Speed

Renvoie:
  unsigned long int : la largeur

bool Image::load | ( | char * | filename,
|  | USGE_Image | type |
| ) |  |  |

Permet de lire l'image donnée et de le charger (Supprimer le fichier déjà chargé si c'est le cas).

Auteur:
  U.Speed

Paramètres:

  | filename | char* : le fichier à ouvrir et charger
  | type | USGE_Image : le type d'image à charger

Renvoie:
  bool : l'état du chargement
  - true : réussite
  - false : échec

bool Image::loadBox | ( | unsigned long int | width,
|  | unsigned long int | height |
| ) |  |  |

Permet de charger un rectangle transparent de la taille donnée.

Auteur:
  U.Speed

Paramètres:

  | width | unsigned long int : largeur de l'image
  | height | unsigned long int : hauteur de l'image

Renvoie:
  bool : l'état du chargement
  - true : réussite
  - false : échec

bool Image::loadFromBuffer | ( | unsigned char * | data,
|  | unsigned long int | bufferLength,
|  | USGE_Image | type |
| ) |  |  |

Permet de lire l'image donnée et de le charger (Supprimer le fichier déjà chargé si c'est le cas).

Auteur:
  U.Speed

Paramètres:

  | data | unsigned char* : les données à lire
  | bufferLength | unsigned long int : la longueur des données à lire
  | type | USGE_Image : le type d'image à charger

Renvoie:
  bool : l'état du chargement
  - true : réussite
  - false : échec

unsigned long int * Image::moveDatas | ( |  | ) |

Permet de déplacer (transfert) les données de l'image chargée vers le pointeur spécifié.

Une fois le déplacement effectué, l'objet courant est effacé (via "clear()") sans supprimer les données.
Il faut donc récupérer les dimensions de l'image avant ce transfert.

Auteur:
  U.Speed

Renvoie:
  unsigned long int* : le pointeur des données

bool Image::write | ( | char * | filename,
|  | USGE_Image | type |
| ) |  |  |

Permet d'écrire l'image donnée dans un fichier JPEG.

Auteur:
  U.Speed

Paramètres:

  | filename | char* : le fichier à ouvrir
  | type | USGE_Image : le type du fichier

Renvoie:
  bool : l'état du chargements
  - true : réussite
  - false : échec

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Image/Image.hpp
- src/Image/Image.cpp
- src/Image/Image_clear.cpp
- src/Image/Image_copyFrom.cpp
- src/Image/Image_fill.cpp
- src/Image/Image_getData.cpp
- src/Image/Image_getHeight.cpp
- src/Image/Image_getWidth.cpp
- src/Image/Image_load.cpp
- src/Image/Image_loadBox.cpp
- src/Image/Image_loadFromBuffer.cpp
- src/Image/Image_loadJPEGFromBuffer.cpp
- src/Image/Image_loadPNGFromBuffer.cpp
- src/Image/Image_loadTGAFromBuffer.cpp
- src/Image/Image_moveDatas.cpp
- src/Image/Image_write.cpp