ScummVM API documentation
MM::Xeen::SpriteResource Class Reference
Inheritance diagram for MM::Xeen::SpriteResource:
MM::Shared::Xeen::SpriteResource

Public Member Functions

 SpriteResource (const Common::Path &filename)
 
 SpriteResource (const Common::Path &filename, int ccMode)
 
void load (const Common::Path &filename)
 
void load (const Common::Path &filename, int ccMode)
 
void draw (Shared::Xeen::XSurface &dest, int frame, const Common::Point &destPos, uint flags=0, int scale=0)
 
void draw (Shared::Xeen::XSurface &dest, int frame)
 
void draw (Graphics::ManagedSurface *dest, int frame, const Common::Point &destPos)
 
void draw (Window &dest, int frame, const Common::Point &destPos, uint flags=0, int scale=0)
 
void draw (int windowIndex, int frame)
 
void draw (int windowIndex, int frame, const Common::Point &destPos, uint flags=0, int scale=0)
 
- Public Member Functions inherited from MM::Shared::Xeen::SpriteResource
 SpriteResource (const Common::Path &filename)
 
 SpriteResource (const SpriteResource &src)
 
SpriteResourceoperator= (const SpriteResource &src)
 
void load (const Common::Path &filename)
 
void clear ()
 
void draw (XSurface &dest, int frame, const Common::Point &destPos, uint flags=0, int scale=0) const
 
void draw (XSurface &dest, int frame) const
 
void draw (Graphics::ManagedSurface *dest, int frame, const Common::Point &destPos) const
 
Common::Point getFrameSize (int frame) const
 
size_t size () const
 
bool empty () const
 

Additional Inherited Members

- Static Public Member Functions inherited from MM::Shared::Xeen::SpriteResource
static void setClippedBottom (int y)
 
- Protected Member Functions inherited from MM::Shared::Xeen::SpriteResource
void load (Common::SeekableReadStream &f)
 
void draw (XSurface &dest, int frame, const Common::Point &destPos, const Common::Rect &bounds, uint flags=0, int scale=0) const
 
void copy (const SpriteResource &src)
 
- Protected Attributes inherited from MM::Shared::Xeen::SpriteResource
Common::Array< IndexEntry_index
 
size_t _filesize
 
byte * _data
 
Common::Path _filename
 
- Static Protected Attributes inherited from MM::Shared::Xeen::SpriteResource
static int _clippedBottom
 

Member Function Documentation

◆ load() [1/2]

void MM::Xeen::SpriteResource::load ( const Common::Path filename)
inline

Load a sprite resource from a given file

◆ load() [2/2]

void MM::Xeen::SpriteResource::load ( const Common::Path filename,
int  ccMode 
)

Load a sprite resource from a given file and archive

◆ draw() [1/6]

void MM::Xeen::SpriteResource::draw ( Shared::Xeen::XSurface dest,
int  frame,
const Common::Point destPos,
uint  flags = 0,
int  scale = 0 
)
inline

Draw a sprite onto a surface

Parameters
destDestination surface
frameFrame number
destPosDestination position
flagsFlags
scaleScale: 0=No scale, SCALE_ENLARGE=Enlarge it 1..15 -> reduces the sprite: the higher, the smaller it'll be

◆ draw() [2/6]

void MM::Xeen::SpriteResource::draw ( Shared::Xeen::XSurface dest,
int  frame 
)
inline

Draw the sprite onto the given surface

Parameters
destDestination surface
frameFrame number

◆ draw() [3/6]

void MM::Xeen::SpriteResource::draw ( Graphics::ManagedSurface dest,
int  frame,
const Common::Point destPos 
)
inline

Draw the sprite onto a given surface

◆ draw() [4/6]

void MM::Xeen::SpriteResource::draw ( Window dest,
int  frame,
const Common::Point destPos,
uint  flags = 0,
int  scale = 0 
)

Draw a sprite onto a specific window

Parameters
destDestination window
frameFrame number
destPosDestination position
flagsFlags
scaleScale: 0=No scale, SCALE_ENLARGE=Enlarge it 1..15 -> reduces the sprite: the higher, the smaller it'll be

◆ draw() [5/6]

void MM::Xeen::SpriteResource::draw ( int  windowIndex,
int  frame 
)

Draw the sprite onto the given window

Parameters
windowIndexDestination window number
frameFrame number

◆ draw() [6/6]

void MM::Xeen::SpriteResource::draw ( int  windowIndex,
int  frame,
const Common::Point destPos,
uint  flags = 0,
int  scale = 0 
)

Draw a sprite onto a given window

Parameters
windowIndexDestination window number
frameFrame number
destPosDestination position
flagsFlags
scaleScale: 0=No scale, SCALE_ENLARGE=Enlarge it 1..15 -> reduces the sprite: the higher, the smaller it'll be

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