Syndicate::Data::SpriteFrame Class Reference

#include <Syndicate/Data/SpriteFrame.h>

Inheritance diagram for Syndicate::Data::SpriteFrame:

List of all members.

Public Member Functions
	SpriteFrame (void)
	~SpriteFrame (void)
void	get (unsigned id, unsigned &first, unsigned &width, unsigned &height, unsigned &flags, unsigned &next) const
unsigned	size (void) const
virtual void	info (void)
bool	load (char const *filename)
unsigned	getLength (void)
Protected Attributes
unsigned	_data_length
Private Attributes
Frame *	_frames
Classes
struct	Frame

---

Detailed Description

Allow to get size information and the sprite compostion for a frame

---

Constructor & Destructor Documentation

Syndicate::Data::SpriteFrame::SpriteFrame

(

void

)

[inline]

Syndicate::Data::SpriteFrame::~SpriteFrame

(

void

)

[inline]

---

Member Function Documentation

void Syndicate::Data::SpriteFrame::get	(	unsigned	id,
		unsigned &	first,
		unsigned &	width,
		unsigned &	height,
		unsigned &	flags,
		unsigned &	next
	)			const

Given the index of the frame, returns the index of the first element of the frame and other informations.

Parameters:

[in]	id	the *index* of the frame
[out]	first	the *index* of the first element that make this frame
[out]	width	the width of the frame
[out]	height	the height of the frame
[out]	flags	some information on the frame
[out]	next	the *index* of the next frame

unsigned Syndicate::Data::SpriteFrame::size

(

void

)

const [inline]

Return the number of frames

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.

Parameters:

[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

Frame* Syndicate::Data::SpriteFrame::_frames [private]

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

---

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

• Syndicate/Data/SpriteFrame.h

---