Assimp  v3.0 (July 2012)
Public Member Functions | Public Attributes
aiTexture Struct Reference

Helper structure to describe an embedded texture. More...

List of all members.

Public Member Functions

 aiTexture ()
bool CheckFormat (const char *s) const
 For compressed textures (mHeight == 0): compare the format hint against a given string.
 ~aiTexture ()

Public Attributes

char achFormatHint [4]
 A hint from the loader to make it easier for applications to determine the type of embedded compressed textures.
unsigned int mHeight
 Height of the texture, in pixels.
unsigned int mWidth
 Width of the texture, in pixels.
aiTexelpcData
 Data of the texture.

Detailed Description

Helper structure to describe an embedded texture.

Normally textures are contained in external files but some file formats embed them directly in the model file. There are two types of embedded textures:

  1. Uncompressed textures. The color data is given in an uncompressed format.
  2. Compressed textures stored in a file format like png or jpg. The raw file bytes are given so the application must utilize an image decoder (e.g. DevIL) to get access to the actual color data.

Constructor & Destructor Documentation

aiTexture::aiTexture ( )
inline
aiTexture::~aiTexture ( )
inline

Member Function Documentation

bool aiTexture::CheckFormat ( const char *  s) const
inline

For compressed textures (mHeight == 0): compare the format hint against a given string.

Parameters:
sInput string. 3 characters are maximally processed. Example values: "jpg", "png"
Returns:
true if the given string matches the format hint

Member Data Documentation

char aiTexture::achFormatHint[4]

A hint from the loader to make it easier for applications to determine the type of embedded compressed textures.

If mHeight != 0 this member is undefined. Otherwise it is set set to '\0\0\0\0' if the loader has no additional information about the texture file format used OR the file extension of the format without a trailing dot. If there are multiple file extensions for a format, the shortest extension is chosen (JPEG maps to 'jpg', not to 'jpeg'). E.g. 'dds\0', 'pcx\0', 'jpg\0'. All characters are lower-case. The fourth character will always be '\0'.

unsigned int aiTexture::mHeight

Height of the texture, in pixels.

If this value is zero, pcData points to an compressed texture in any format (e.g. JPEG).

unsigned int aiTexture::mWidth

Width of the texture, in pixels.

If mHeight is zero the texture is compressed in a format like JPEG. In this case mWidth specifies the size of the memory area pcData is pointing to, in bytes.

aiTexel* aiTexture::pcData

Data of the texture.

Points to an array of mWidth * mHeight aiTexel's. The format of the texture data is always ARGB8888 to make the implementation for user of the library as easy as possible. If mHeight = 0 this is a pointer to a memory buffer of size mWidth containing the compressed texture data. Good luck, have fun!


The documentation for this struct was generated from the following file: