Snapshot

#include <Media/Snapshot.h>

class Snapshot

Defined in Media/Snapshot.h:59

A snapshot of the emulator state.

Public Methods

Return	Name	Description
	Snapshot inline	Creates a copy of a snapshot.
	Snapshot inline	Reads a snapshot from a file.
	Snapshot inline	Reads a snapshot from a memory buffer.
	Snapshot	Creates an empty snapshot with the given capacity.
	Snapshot	Takes a snapshot of the emulator state.
	Snapshot	Takes a snapshot of the emulator state and compresses it.
bool	isCompatiblePath virtual const inline override	Returns true if the given path points to a snapshot file.
void	didLoad virtual override	Called after the snapshot has been loaded.
std::pair< isize, isize >	previewImageSize const	Returns the size of the preview image (width, height).
const u32 *	previewImageData const	Returns the pixel data of the preview image.
time_t	timestamp const	Returns the time the snapshot was taken.
bool	isTooOld const	Returns true if the snapshot was created by an older, incompatible version.
bool	isTooNew const	Returns true if the snapshot was created by a newer version.
bool	isBeta const	Returns true if the snapshot was created by a beta version.
bool	matches inline	Returns true if the snapshot can be restored by this version.
SnapshotHeader *	getHeader const inline	Returns a pointer to the snapshot header.
const Thumbnail &	getThumbnail const inline	Returns the preview image.
void	takeScreenshot	Records a screenshot.
utl::Compressor	compressor const inline	Returns the compression method.
bool	isCompressed const inline	Returns true if the snapshot is compressed.
void	compress	Compresses the snapshot with the given method.
void	uncompress	Uncompresses the snapshot.

---

Snapshot

inline

inline Snapshot(const Snapshot & other)

Defined in Media/Snapshot.h:72

Creates a copy of a snapshot.

---

Snapshot

inline

inline Snapshot(const fs::path & path)

Defined in Media/Snapshot.h:74

Reads a snapshot from a file.

---

Snapshot

inline

inline Snapshot(const u8 * buf, isize len)

Defined in Media/Snapshot.h:76

Reads a snapshot from a memory buffer.

---

Snapshot

Snapshot(isize capacity)

Defined in Media/Snapshot.h:78

Creates an empty snapshot with the given capacity.

---

Snapshot

Snapshot(Amiga & amiga)

Defined in Media/Snapshot.h:80

Takes a snapshot of the emulator state.

---

Snapshot

Snapshot(Amiga & amiga, utl::Compressor compressor)

Defined in Media/Snapshot.h:82

Takes a snapshot of the emulator state and compresses it.

---

isCompatiblePath

virtual const inline override

virtual inline bool isCompatiblePath(const fs::path & path) const override

Defined in Media/Snapshot.h:90

Returns true if the given path points to a snapshot file.

Reimplements

• AnyFile::isCompatiblePath

---

didLoad

virtual override

virtual void didLoad() override

Defined in Media/Snapshot.h:92

Called after the snapshot has been loaded.

Reimplements

• AnyFile::didLoad

---

previewImageSize

const

std::pair< isize, isize > previewImageSize() const

Defined in Media/Snapshot.h:102

Returns the size of the preview image (width, height).

---

previewImageData

const

const u32 * previewImageData() const

Defined in Media/Snapshot.h:104

Returns the pixel data of the preview image.

---

timestamp

const

time_t timestamp() const

Defined in Media/Snapshot.h:106

Returns the time the snapshot was taken.

---

isTooOld

const

bool isTooOld() const

Defined in Media/Snapshot.h:110

Returns true if the snapshot was created by an older, incompatible version.

---

isTooNew

const

bool isTooNew() const

Defined in Media/Snapshot.h:112

Returns true if the snapshot was created by a newer version.

---

isBeta

const

bool isBeta() const

Defined in Media/Snapshot.h:114

Returns true if the snapshot was created by a beta version.

---

matches

inline

inline bool matches()

Defined in Media/Snapshot.h:116

Returns true if the snapshot can be restored by this version.

---

getHeader

const inline

inline SnapshotHeader * getHeader() const

Defined in Media/Snapshot.h:120

Returns a pointer to the snapshot header.

---

getThumbnail

const inline

inline const Thumbnail & getThumbnail() const

Defined in Media/Snapshot.h:124

Returns the preview image.

---

takeScreenshot

void takeScreenshot(Amiga & amiga)

Defined in Media/Snapshot.h:131

Records a screenshot.

---

compressor

const inline

inline utl::Compressor compressor() const

Defined in Media/Snapshot.h:140

Returns the compression method.

---

isCompressed

const inline

inline bool isCompressed() const

Defined in Media/Snapshot.h:144

Returns true if the snapshot is compressed.

---

compress

void compress(utl::Compressor method)

Defined in Media/Snapshot.h:148

Compresses the snapshot with the given method.

---

uncompress

void uncompress()

Defined in Media/Snapshot.h:150

Uncompresses the snapshot.

Public Static Methods

Return	Name	Description
bool	isCompatible static	Checks whether a file contains a snapshot.

---

isCompatible

static

static bool isCompatible(const fs::path & path)

Defined in Media/Snapshot.h:64

Checks whether a file contains a snapshot.