Public Member Functions | Static Public Member Functions | Public Attributes

# USpeedGameEngine::Material::Texture Class Reference

Classe contenant les informations de texturage. More...

List of all members.

## Public Member Functions

| Texture ()
| Construteur par défaut.
| ~Texture ()
| Destructeur par défaut.
bool | is16Bits ()
| Permet de savoir si la texture est en mode 16 bits (sinon elle est en 32 bits).
void | clear ()
| Permet d'effacer les données et ré-initialiser les variables.
bool | fromImage (Image *image)
| Chargement de la texture depuis l'image spécifiée (par transfert).
bool | fromImageFile (char *filename, USGE_Image type)
| Chargement de la texture depuis l'image du fichier spécifié.
bool | fromImageBuffer (unsigned char *data, unsigned long int bufferLength, USGE_Image type)
| Chargement de la texture depuis l'image du fichier en mémoire spécifié.
bool | fromPointer (char *ptrData, unsigned long int width, unsigned long int height)
| Chargement de la texture depuis un pointeur de données spécifié.
void | loadToGL ()
| Charge les données de texture pour l'affichage matériel en mode "RGBA".
void | loadToGL (bool mode16Bits)
| Charge les données de texture pour l'affichage matériel en mode "RGBA".
unsigned long int | getWidth ()
| Retourne la largeur actuelle de la texture.
unsigned long int | getHeight ()
| Retourne la hauteur actuelle de la texture.
unsigned int | getTextureID ()
| L'identifiant de texture sous OpenGL ou un identifiant interne sur PSP.
char * | getData ()
| Retourne le pointeur des données de l'image.
void | setMode (USGE_TextureMode pMode)
| Permet de choisir le mode d'affichage de la texture : NEAREST par défaut.
USGE_TextureMode | getMode ()
| Retourne le mode d'affichage de la texture actuellement choisi.

## Static Public Member Functions

static void | setDefaultMode (USGE_TextureMode pMode)
| Permet de choisir le mode d'affichage par défaut de la texture.
static USGE_TextureMode | getDefaultMode ()
| Retourne le mode d'affichage par défaut de la texture actuellement choisi.

## Public Attributes

unsigned int | textureID
| Identifiant de la texture sous OpenGL.
char * | data
| Données de l'image chargée.
unsigned long int | width
| Largeur de l'image chargée.
unsigned long int | height
| Hauteur de l'image chargée.
USGE_TextureMode | mode
| Le mode d'affichage de la texture.
bool | prepared
| Permet de savoir si la texture est préparée et prête à l'emploi.
bool | is4444
| Permet de savoir si la texture est en mode 16 bits (sinon elle est en 32 bits).

## Detailed Description

Classe contenant les informations de texturage.

Pour charger une texture, il faut passer par la classe "Image" qui va charger effectivement l'image et effectuer un transfert via la fonction "fromImage".

Author:
  U.Speed

## Constructor & Destructor Documentation

Material::Texture::Texture | ( |  | ) |

Construteur par défaut.

Author:
  U.Speed

Material::Texture::~Texture | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

void Material::Texture::clear | ( |  | ) |

Permet d'effacer les données et ré-initialiser les variables.

Author:
  U.Speed

bool Material::Texture::fromImage | ( | Image * | image | ) |

Chargement de la texture depuis l'image spécifiée (par transfert).

Comme il s'agit d'un transfert, l'image source perd le pointeur des données.

Author:
  U.Speed

Parameters:

  | image | Image* : l'image concernée

Returns:
  bool : l'état du transfert

bool Material::Texture::fromImageBuffer | ( | unsigned char * | data,
|  | unsigned long int | bufferLength,
|  | USGE_Image | type |
| ) |  |  |

Chargement de la texture depuis l'image du fichier en mémoire spécifié.

Author:
  U.Speed

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

Parameters:

  | 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

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

bool Material::Texture::fromImageFile | ( | char * | filename,
|  | USGE_Image | type |
| ) |  |  |

Chargement de la texture depuis l'image du fichier spécifié.

Author:
  U.Speed

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

Parameters:

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

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

bool Material::Texture::fromPointer | ( | char * | ptrData,
|  | unsigned long int | width,
|  | unsigned long int | height |
| ) |  |  |

Chargement de la texture depuis un pointeur de données spécifié.

Il ne s'agit pas d'une copie : le pointeur est utilisé tel quel.
De ce fait, il est désalloué automatiquement dans cette classe.
Il ne faut pas le désalloué ailleurs !

Author:
  U.Speed

Parameters:

  | ptrData | char* : les nouvelles données.
  | width | unsigned long int : la largeur
  | height | unsigned long int : la hauteur

Returns:
  bool : l'état du transfert

char * Material::Texture::getData | ( |  | ) |

Retourne le pointeur des données de l'image.

Attention au pointeur nul éventuel !

Author:
  U.Speed

Returns:
  char* : les données de la texture ou pointeur nul.

USGE_TextureMode Material::Texture::getDefaultMode | ( |  | ) | `[static]`

Retourne le mode d'affichage par défaut de la texture actuellement choisi.

Author:
  U.Speed

Returns:
  USGE_TextureMode : le mode

unsigned long int Material::Texture::getHeight | ( |  | ) |

Retourne la hauteur actuelle de la texture.

Author:
  U.Speed

Returns:
  unsigned long int : la hauteur

USGE_TextureMode Material::Texture::getMode | ( |  | ) |

Retourne le mode d'affichage de la texture actuellement choisi.

Author:
  U.Speed

Returns:
  USGE_TextureMode : le mode

unsigned int Material::Texture::getTextureID | ( |  | ) |

L'identifiant de texture sous OpenGL ou un identifiant interne sur PSP.

Author:
  U.Speed

Returns:
  unsigned int : l'identifiant

unsigned long int Material::Texture::getWidth | ( |  | ) |

Retourne la largeur actuelle de la texture.

Author:
  U.Speed

Returns:
  unsigned long int : la largeur

bool Material::Texture::is16Bits | ( |  | ) |

Permet de savoir si la texture est en mode 16 bits (sinon elle est en 32 bits).

Author:
  U.Speed

Returns:
  bool : `true` si la texture est en mode 16 bits, sinon elle est en 32 bits.

void Material::Texture::loadToGL | ( |  | ) |

Charge les données de texture pour l'affichage matériel en mode "RGBA".

La texture doit être en 32 bits et reste en 32 bits.

Author:
  U.Speed

See also:
  void Material::Texture::loadToGL(bool mode16bits)

void Material::Texture::loadToGL | ( | bool | mode16bits | ) |

Charge les données de texture pour l'affichage matériel en mode "RGBA".

La texture doit être en 32 bits.

Author:
  U.Speed

Parameters:

  | mode16bits | bool : Mode 16 bits activé (conversion de la texture 32 bits en 16 bits)

void Material::Texture::setDefaultMode | ( | USGE_TextureMode | pMode | ) | `[static]`

Permet de choisir le mode d'affichage par défaut de la texture.

Il s'agit du mode pour toute nouvelle texture ou le mode restauré lors de l'appel de "clear()".

Author:
  U.Speed

Parameters:

  | pMode | USGE_TextureMode : le mode

void Material::Texture::setMode | ( | USGE_TextureMode | pMode | ) |

Permet de choisir le mode d'affichage de la texture : NEAREST par défaut.

La valeur par défaut peut être modifiée par "setDefaultMode()".
Il faut changer de mode avant l'appel de la fonction "loadToGL()".

Author:
  U.Speed

Parameters:

  | pMode | USGE_TextureMode : le mode

The documentation for this class was generated from the following files:

- src/Material/Texture.hpp
- src/Material/Texture.cpp
- src/Material/Texture_clear.cpp
- src/Material/Texture_fromImage.cpp
- src/Material/Texture_fromImageBuffer.cpp
- src/Material/Texture_fromImageFile.cpp
- src/Material/Texture_fromPointer.cpp
- src/Material/Texture_getData.cpp
- src/Material/Texture_getDefaultMode.cpp
- src/Material/Texture_getHeight.cpp
- src/Material/Texture_getMode.cpp
- src/Material/Texture_getTextureID.cpp
- src/Material/Texture_getWidth.cpp
- src/Material/Texture_is16Bits.cpp
- src/Material/Texture_loadToGL.cpp
- src/Material/Texture_setDefaultMode.cpp
- src/Material/Texture_setMode.cpp