LibPkg
|
An interface class to represent a sprite file. More...
#include <sprite_file.h>
Classes | |
class | already_exists |
An exception class for reporting already-exists errors. More... | |
class | corrupt |
An exception class for reporting corrupt-sprite-file errors. More... | |
class | not_found |
An exception class for reporting not-found errors. More... | |
class | sprite_info |
A class to represent a sprite within a sprite file. More... | |
Public Types | |
typedef unsigned long | uint32 |
A type to represent an unsigned 32-bit integer. More... | |
Public Member Functions | |
sprite_file (const string &pathname, bool writable=false) | |
Construct sprite file object. More... | |
~sprite_file () | |
Destroy sprite file object. More... | |
unsigned int | size () const |
Get number of sprites. More... | |
const sprite_info & | operator[] (unsigned int index) const |
Get const sprite information record at index. More... | |
const sprite_info * | find (const string &name) const |
Find const sprite information record for sprite name. More... | |
void | copy (sprite_file &src, const string &name) |
Copy sprite from another sprite file. More... | |
An interface class to represent a sprite file.
typedef unsigned long pkg::sprite_file::uint32 |
A type to represent an unsigned 32-bit integer.
pkg::sprite_file::sprite_file | ( | const string & | pathname, |
bool | writable = false |
||
) |
Construct sprite file object.
pathname | the pathname of the sprite file |
writable | true to open read-write, false to open read-only |
References find(), and pkg::sprite_file::sprite_info::name().
pkg::sprite_file::~sprite_file | ( | ) |
Destroy sprite file object.
|
inline |
const sprite_info& pkg::sprite_file::operator[] | ( | unsigned int | index | ) | const |
Get const sprite information record at index.
index | the index |
Referenced by size().
const sprite_file::sprite_info * pkg::sprite_file::find | ( | const string & | name | ) | const |
Find const sprite information record for sprite name.
name | the sprite name |
Referenced by copy(), size(), and sprite_file().
void pkg::sprite_file::copy | ( | sprite_file & | src, |
const string & | name | ||
) |
Copy sprite from another sprite file.
src | the sprite file containing the source |
name | the sprite name |
References find(), pkg::sprite_file::sprite_info::name(), pkg::sprite_file::sprite_info::offset(), and pkg::sprite_file::sprite_info::size().
Referenced by size().
Reference Manual | LibPkg | Version 0.9.0 (4 Sep 2020) |