LibPkg
Public Member Functions | List of all members
pkg::sprite_file::sprite_info Class Reference

A class to represent a sprite within a sprite file. More...

#include <sprite_file.h>

Public Member Functions

 sprite_info ()
 Construct sprite information record. More...
 
 sprite_info (std::istream &in)
 Construct sprite information record from stream. More...
 
 ~sprite_info ()
 Destroy sprite information record. More...
 
const uint32 offset () const
 Get file offset. More...
 
const uint32 size () const
 Get size. More...
 
const string & name () const
 Get sprite name. More...
 

Detailed Description

A class to represent a sprite within a sprite file.

Constructor & Destructor Documentation

pkg::sprite_file::sprite_info::sprite_info ( )

Construct sprite information record.

pkg::sprite_file::sprite_info::sprite_info ( std::istream &  in)

Construct sprite information record from stream.

Parameters
inthe input stream
pkg::sprite_file::sprite_info::~sprite_info ( )

Destroy sprite information record.

Member Function Documentation

const uint32 pkg::sprite_file::sprite_info::offset ( ) const
inline

Get file offset.

Returns
the file offset of the sprite

Referenced by pkg::sprite_file::copy().

const uint32 pkg::sprite_file::sprite_info::size ( ) const
inline

Get size.

Returns
the size of the sprite

Referenced by pkg::sprite_file::copy().

const string& pkg::sprite_file::sprite_info::name ( ) const
inline

Get sprite name.

Returns
the sprite name

Referenced by pkg::sprite_file::copy(), and pkg::sprite_file::sprite_file().


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

Reference Manual LibPkg Version 0.6.1 (28 Jan 2015)