Syndicate::Data::SpriteTab Class Reference

#include <Syndicate/Data/SpriteTab.h>

Inheritance diagram for Syndicate::Data::SpriteTab:

Syndicate::Data::File List of all members.

Public Member Functions

 SpriteTab (void)
 ~SpriteTab (void)
void get (unsigned id, unsigned &offset, unsigned &width, unsigned &height) const
unsigned size (void) const
virtual void info (void)
bool load (char const *filename)
unsigned getLength (void)

Protected Attributes

unsigned _data_length

Private Attributes



struct  Entry

Detailed Description

Allow to get size information and the offset of the data for sprites.

Constructor & Destructor Documentation

Syndicate::Data::SpriteTab::SpriteTab ( void   )  [inline]

Syndicate::Data::SpriteTab::~SpriteTab ( void   )  [inline]

Member Function Documentation

void Syndicate::Data::SpriteTab::get ( unsigned  id,
unsigned &  offset,
unsigned &  width,
unsigned &  height 
) const

Given the index of the sprite, returns the *offset* of the data in the SpriteData structure and other informations.

[in] id the *index* of the sprite
[out] offset the *offset* of the data in the SpriteData structure
[out] width width in pixels of the sprite
[out] height height in pixels of the sprite

unsigned Syndicate::Data::SpriteTab::size ( void   )  const [inline]

Return the number of entries

virtual void Syndicate::Data::File::info ( void   )  [virtual, inherited]

In debug mode it display the informations.

bool Syndicate::Data::File::load ( char const *  filename  )  [inherited]

This method load the content (unpacked) of the file at the adress pointed by _data.

[in] filename the name of the file.
Return values:
true if success.
false if fails. If previous file is loaded, the data keep unaffected.

unsigned Syndicate::Data::File::getLength ( void   )  [inline, inherited]

Member Data Documentation

Entry* Syndicate::Data::SpriteTab::_entries [private]

unsigned Syndicate::Data::File::_data_length [protected, inherited]

The documentation for this class was generated from the following file:
Generated on Sun Sep 30 13:08:36 2007 for libSyndicate by  doxygen 1.5.2