ScummVM API documentation
Stark::VisualImageXMG Class Reference

#include <image.h>

Inheritance diagram for Stark::VisualImageXMG:
Stark::Visual

Public Member Functions

 VisualImageXMG (Gfx::Driver *gfx)
 
void load (Common::ReadStream *stream)
 
void readOriginalSize (Common::ReadStream *stream)
 
bool loadPNG (Common::SeekableReadStream *stream)
 
void render (const Common::Point &position, bool useOffset)
 
void render (const Common::Point &position, bool useOffset, bool unscaled)
 
void setHotSpot (const Common::Point &hotspot)
 
Common::Point getHotspot () const
 
void setFadeLevel (float fadeLevel)
 
bool isPointSolid (const Common::Point &point) const
 
int getWidth () const
 
int getHeight () const
 
const Graphics::SurfacegetSurface () const
 
- Public Member Functions inherited from Stark::Visual
 Visual (VisualType type)
 
template<class T >
T * get ()
 

Static Public Attributes

static const VisualType TYPE = Visual::kImageXMG
 

Additional Inherited Members

- Public Types inherited from Stark::Visual
enum  VisualType {
  kImageXMG = 2, kRendered = 3, kImageText = 4, kSmackerStream = 5,
  kActor = 6, kSmackerFMV = 7, kEffectFish = 8, kEffectBubbles = 9,
  kEffectFirefly = 10, kExplodingImage = 100, kFlashingImage = 101
}
 

Detailed Description

XMG (still image) renderer

Member Function Documentation

◆ load()

void Stark::VisualImageXMG::load ( Common::ReadStream stream)

Load the pixel data from a XMG image

◆ readOriginalSize()

void Stark::VisualImageXMG::readOriginalSize ( Common::ReadStream stream)

Load the size from an XMG image

◆ loadPNG()

bool Stark::VisualImageXMG::loadPNG ( Common::SeekableReadStream stream)

Load the pixel data from a PNG image

◆ setHotSpot()

void Stark::VisualImageXMG::setHotSpot ( const Common::Point hotspot)

Set an offset used when rendering

◆ setFadeLevel()

void Stark::VisualImageXMG::setFadeLevel ( float  fadeLevel)

The fade level is added to the color value of each pixel

It is a value between -1 and 1

◆ isPointSolid()

bool Stark::VisualImageXMG::isPointSolid ( const Common::Point point) const

Perform a transparency hit test on an image point

◆ getWidth()

int Stark::VisualImageXMG::getWidth ( ) const

Get the width in pixels

◆ getHeight()

int Stark::VisualImageXMG::getHeight ( ) const

Get the height in pixels

◆ getSurface()

const Graphics::Surface* Stark::VisualImageXMG::getSurface ( ) const

Get a read only pointer to the surface backing the image


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