fs::ras::TgaLdr_t Class Reference

#include <fsTgaLdr.h>

Collaboration diagram for fs::ras::TgaLdr_t:

Collaboration graph
[legend]
List of all members.

Detailed Description

TGA image loader / data holder.

The class loads a TGA image file and then holds its image data. Currently, two formats RGB-888 and RGBA-8888 are supported. After loading, the data is rearranged if necessary to ensure R-G-B-(A) channel order.

Examples:

_tests/fsTgaLdr/main.cpp.

Definition at line 29 of file fsTgaLdr.h.

Public Member Functions

 TgaLdr_t (const char *pszFile)
 Loads a TGA file using the given filename.
 ~TgaLdr_t ()
bool IsValid () const
 Checks the internal state / correct construction.
int GetW () const
 Returns the width of the image.
int GetH () const
 Returns the height of the image.
const PxFmt888_tGetData888 () const
 Returns a pointer to RGB-888 data or 0 if the format doesn't match.
const PxFmt8888_tGetData8888 () const
 Returns a pointer to RGBA-8888 data or 0 if the format doesn't match.

Private Member Functions

 TgaLdr_t ()
 No def ctor.
 TgaLdr_t (const TgaLdr_t &)
 No copy.
TgaLdr_toperator= (const TgaLdr_t &)
 No assignment.

Private Attributes

void * m_pImpl
 The PIPML idiom is used.

Classes

struct  PxFmt8888_t
 TgaLdr_t : RGBA-8888 pixel format. More...
struct  PxFmt888_t
 TgaLdr_t : RGB-888 pixel format. More...


Constructor & Destructor Documentation

TgaLdr_t::TgaLdr_t ( const char *  pszFile  )  [explicit]

Loads a TGA file using the given filename.

Definition at line 282 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

TgaLdr_t::~TgaLdr_t (  ) 

Definition at line 288 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

fs::ras::TgaLdr_t::TgaLdr_t (  )  [private]

No def ctor.

fs::ras::TgaLdr_t::TgaLdr_t ( const TgaLdr_t  )  [private]

No copy.


Member Function Documentation

const TgaLdr_t::PxFmt888_t * TgaLdr_t::GetData888 (  )  const

Returns a pointer to RGB-888 data or 0 if the format doesn't match.

Examples:
_tests/fsTgaLdr/main.cpp.

Definition at line 312 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

const TgaLdr_t::PxFmt8888_t * TgaLdr_t::GetData8888 (  )  const

Returns a pointer to RGBA-8888 data or 0 if the format doesn't match.

Examples:
_tests/fsTgaLdr/main.cpp.

Definition at line 318 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

int TgaLdr_t::GetH (  )  const

Returns the height of the image.

Examples:
_tests/fsTgaLdr/main.cpp.

Definition at line 306 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

int TgaLdr_t::GetW (  )  const

Returns the width of the image.

Examples:
_tests/fsTgaLdr/main.cpp.

Definition at line 300 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

bool TgaLdr_t::IsValid (  )  const

Checks the internal state / correct construction.

Examples:
_tests/fsTgaLdr/main.cpp.

Definition at line 294 of file fsTgaLdr.cpp.

References FS_ASSERT_MSG, and m_pImpl.

TgaLdr_t& fs::ras::TgaLdr_t::operator= ( const TgaLdr_t  )  [private]

No assignment.


Member Data Documentation

void* fs::ras::TgaLdr_t::m_pImpl [private]

The PIPML idiom is used.

Definition at line 59 of file fsTgaLdr.h.


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

FipS' Code (Thu Feb 15 22:43:53 2007) - (c) Filip STOKLAS (FipS) - [ www ] [ Guest Book ]