Description

API for managing screen thumbnails used for save games.

Functions
bool	Graphics::checkThumbnailHeader (Common::SeekableReadStream &in)

bool	Graphics::skipThumbnail (Common::SeekableReadStream &in)

bool	Graphics::loadThumbnail (Common::SeekableReadStream &in, Graphics::Surface *&thumbnail, bool skipThumbnail=false)

bool	Graphics::loadThumbnail (Common::SeekableReadStream &in, Graphics::ManagedSurface *&thumbnail, bool skipThumbnail=false)

bool	Graphics::createThumbnail (Graphics::Surface &thumb)

bool	Graphics::saveThumbnail (Common::WriteStream &out)

bool	Graphics::saveThumbnail (Common::WriteStream &out, const Graphics::Surface &thumb)

bool	Graphics::createScreenShot (Graphics::Surface &surf)

Function Documentation

bool Graphics::checkThumbnailHeader ( Common::SeekableReadStream & in )

Checks for presence of the thumbnail save header. Seeks automatically back to start position after check.

Parameters

in	stream to check for header

bool Graphics::skipThumbnail ( Common::SeekableReadStream & in )

Skips a thumbnail, if present.

Parameters

in	stream to process

bool Graphics::loadThumbnail	(	Common::SeekableReadStream &	in,
		Graphics::Surface *&	thumbnail,
		bool	skipThumbnail = `false`
	)

Loads a thumbnail from the given input stream.

bool Graphics::loadThumbnail	(	Common::SeekableReadStream &	in,
		Graphics::ManagedSurface *&	thumbnail,
		bool	skipThumbnail = `false`
	)

Loads a thumbnail from the given input stream.

bool Graphics::createThumbnail ( Graphics::Surface & thumb )

Creates a thumbnail from screen contents.

bool Graphics::saveThumbnail ( Common::WriteStream & out )

Saves a thumbnail to the given write stream. Automatically creates a thumbnail from screen contents.

bool Graphics::saveThumbnail	(	Common::WriteStream &	out,
		const Graphics::Surface &	thumb
	)

Saves a (given) thumbnail to the given write stream.

bool Graphics::createScreenShot ( Graphics::Surface & surf )

Grabs framebuffer into surface

Parameters

surf a surface