Snapshot

#include <Media/Snapshot.h>

class Snapshot

Defined in Media/Snapshot.h:69

A snapshot of the emulator state

A snapshot contains the complete internal state of the emulator together with a preview image. Snapshots are created with C64API::takeSnapshot() and can be restored with C64API::loadSnapshot().

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.
FileType	type virtual const inline override	Returns the media type of this file.
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.
u8 *	getSnapshotData const inline	Returns a pointer to the core data.
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:88

Creates a copy of a snapshot.

---

Snapshot

inline

inline Snapshot(const fs::path & path)

Defined in Media/Snapshot.h:90

Reads a snapshot from a file.

---

Snapshot

inline

inline Snapshot(const u8 * buf, isize len)

Defined in Media/Snapshot.h:92

Reads a snapshot from a memory buffer.

---

Snapshot

Snapshot(isize capacity)

Defined in Media/Snapshot.h:94

Creates an empty snapshot with the given capacity.

---

Snapshot

Snapshot(C64 & c64)

Defined in Media/Snapshot.h:96

Takes a snapshot of the emulator state.

---

Snapshot

Snapshot(C64 & c64, utl::Compressor compressor)

Defined in Media/Snapshot.h:98

Takes a snapshot of the emulator state and compresses it.

---

type

virtual const inline override

virtual inline FileType type() const override

Defined in Media/Snapshot.h:112

Returns the media type of this file.

Reimplements

• AnyFile::type

---

previewImageSize

const

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

Defined in Media/Snapshot.h:123

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

---

previewImageData

const

const u32 * previewImageData() const

Defined in Media/Snapshot.h:125

Returns the pixel data of the preview image.

---

timestamp

const

time_t timestamp() const

Defined in Media/Snapshot.h:127

Returns the time the snapshot was taken.

---

isTooOld

const

bool isTooOld() const

Defined in Media/Snapshot.h:131

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

---

isTooNew

const

bool isTooNew() const

Defined in Media/Snapshot.h:133

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

---

isBeta

const

bool isBeta() const

Defined in Media/Snapshot.h:135

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

---

matches

inline

inline bool matches()

Defined in Media/Snapshot.h:137

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

---

getHeader

const inline

inline SnapshotHeader * getHeader() const

Defined in Media/Snapshot.h:141

Returns a pointer to the snapshot header.

---

getThumbnail

const inline

inline const Thumbnail & getThumbnail() const

Defined in Media/Snapshot.h:145

Returns the preview image.

---

getSnapshotData

const inline

inline u8 * getSnapshotData() const

Defined in Media/Snapshot.h:149

Returns a pointer to the core data.

---

takeScreenshot

void takeScreenshot(C64 & c64)

Defined in Media/Snapshot.h:152

Records a screenshot.

---

compressor

const inline

inline utl::Compressor compressor() const

Defined in Media/Snapshot.h:161

Returns the compression method.

---

isCompressed

const inline

inline bool isCompressed() const

Defined in Media/Snapshot.h:165

Returns true if the snapshot is compressed.

---

compress

void compress(utl::Compressor method)

Defined in Media/Snapshot.h:169

Compresses the snapshot with the given method.

---

uncompress

void uncompress()

Defined in Media/Snapshot.h:171

Uncompresses the snapshot.

Public Static Methods

Return	Name	Description
bool	isCompatible static	Checks whether a file, a buffer or a memory region contains a snapshot.

---

isCompatible

static

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

Defined in Media/Snapshot.h:78

Checks whether a file, a buffer or a memory region contains a snapshot.