"L. Spiro Engine"
Classes | Static Public Member Functions | Protected Types

lsi::CTga Class Reference

Loading a TGA file. More...

#include <LSITga.h>

List of all members.

Classes

struct  LSI_TGAFOOTER
struct  LSI_TGAHEADER

Static Public Member Functions

static LSBOOL LSE_CALL LoadTga (const LSUINT8 *_pui8FileData, LSUINT32 _ui32DataLen, LSUINT32 &_ui32Width, LSUINT32 &_ui32Height, LSI_PIXEL_FORMAT &_pfFormat, CImageLib::CTexelBuffer &_tbReturn)
static LSBOOL LSE_CALL LoadTga (const LSCHAR *_pcFile, LSUINT32 &_ui32Width, LSUINT32 &_ui32Height, LSI_PIXEL_FORMAT &_pfFormat, CImageLib::CTexelBuffer &_tbReturn)

Protected Types

typedef struct
lsi::CTga::LSI_TGAHEADER
LPLSI_TGAHEADER
typedef struct
lsi::CTga::LSI_TGAHEADER 
LPCLSI_TGAHEADER
typedef struct
lsi::CTga::LSI_TGAFOOTER
LPLSI_TGAFOOTER
typedef struct
lsi::CTga::LSI_TGAFOOTER 
LPCLSI_TGAFOOTER

Detailed Description

Loading a TGA file.

Class CTga Description: Loading a TGA file.


Member Typedef Documentation

The TGA file footer. Not used, but can be used for extra security.

The TGA file header.


Member Function Documentation

static LSBOOL LSE_CALL lsi::CTga::LoadTga ( const LSUINT8 *  _pui8FileData,
LSUINT32  _ui32DataLen,
LSUINT32 &  _ui32Width,
LSUINT32 &  _ui32Height,
LSI_PIXEL_FORMAT _pfFormat,
CImageLib::CTexelBuffer _tbReturn 
) [static]

Load a TGA file from memory.

Parameters:
_pui8FileDataThe in-memory image of the file.
_ui32DataLenThe length of the in-memory image of the file.
_ui32WidthThe returned width of the image.
_ui32HeightThe returned height of the image.
_pfFormatIndicates the format of the converted data held in _tbReturn.
_tbReturnThe returned data.
Returns:
Returns true if the file was successfully loaded. False indicates an invalid file or lack of RAM.
static LSBOOL LSE_CALL lsi::CTga::LoadTga ( const LSCHAR *  _pcFile,
LSUINT32 &  _ui32Width,
LSUINT32 &  _ui32Height,
LSI_PIXEL_FORMAT _pfFormat,
CImageLib::CTexelBuffer _tbReturn 
) [static]

Load a TGA file from a file.

Parameters:
_pcFileFile from which to load the bitmap data. Must be in UTF-8 format.
_ui32WidthThe returned width of the image.
_ui32HeightThe returned height of the image.
_pfFormatIndicates the format of the converted data held in _tbReturn.
_tbReturnThe returned data.
Returns:
Returns true if the file was successfully loaded. False indicates an invalid file or lack of RAM.

The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator