MemoryAPI

#include <VAmiga.h>

class MemoryAPI

Defined in VAmiga.h:936

API of the memory.

Public Attributes

Return	Name	Description
MemoryDebuggerAPI	debugger	The memory debugger.

---

debugger

MemoryDebuggerAPI debugger

Type: MemoryDebuggerAPI

Defined in VAmiga.h:945

The memory debugger.

Public Methods

Return	Name	Description
const MemConfig &	getConfig const	Returns the component's current configuration.
const MemInfo &	getInfo const	Returns the component's current state.
const MemInfo &	getCachedInfo const	Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).
const MemMetrics &	getMetrics const	Returns statistical information about the components.
const MemMetrics &	getCachedMetrics const	Returns the most recent metrics snapshot recorded by the emulator thread (see getMetrics()).
retro::vault::RomTraits	getRomTraits const	Provides details about the installed ROM, WOM, or ROM extension.
retro::vault::RomTraits	getWomTraits const	Returns the traits of the installed WOM (see getRomTraits()).
retro::vault::RomTraits	getExtTraits const	Returns the traits of the installed ROM extension (see getRomTraits()).
void	loadRom	Loads a ROM from a file The ROM type is determined automatically.
void	loadRom	Loads a ROM provided by a memory buffer.
void	loadExt	Loads a ROM extension from a file (see loadRom()).
void	loadExt	Loads a ROM extension from a memory buffer (see loadRom()).
void	loadRomAsync	Asynchronous version of loadRom() and loadExt(): queues the request and returns at once.
void	loadExtAsync	Asynchronous version of loadExt(): queues the request and returns at once.
void	saveRom	Saves a Rom to disk.
void	saveWom	Saves the WOM to disk (see saveRom()).
void	saveExt	Saves the ROM extension to disk (see saveRom()).
void	deleteRom	Removes a ROM.
void	deleteWom	Removes the WOM (see deleteRom()).
void	deleteExt	Removes the ROM extension (see deleteRom()).

---

getConfig

const

const MemConfig & getConfig() const

Defined in VAmiga.h:952

Returns the component's current configuration.

---

getInfo

const

const MemInfo & getInfo() const

Defined in VAmiga.h:963

Returns the component's current state.

getInfo() reads the live state on the calling thread. The result is only consistent if the emulator is paused or suspended. getCachedInfo() returns the snapshot the emulator thread has recorded most recently, which is the one to use while the emulator runs. Both return references that can be overwritten by a later call or by the emulator thread, so copy the data if you need to keep it.

---

getCachedInfo

const

const MemInfo & getCachedInfo() const

Defined in VAmiga.h:965

Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).

---

getMetrics

const

const MemMetrics & getMetrics() const

Defined in VAmiga.h:976

Returns statistical information about the components.

getMetrics() reads the live state on the calling thread. The result is only consistent if the emulator is paused or suspended. getCachedMetrics() returns the snapshot the emulator thread has recorded most recently, which is the one to use while the emulator runs. Both return references that can be overwritten by a later call or by the emulator thread, so copy the data if you need to keep it.

---

getCachedMetrics

const

const MemMetrics & getCachedMetrics() const

Defined in VAmiga.h:978

Returns the most recent metrics snapshot recorded by the emulator thread (see getMetrics()).

---

getRomTraits

const

retro::vault::RomTraits getRomTraits() const

Defined in VAmiga.h:982

Provides details about the installed ROM, WOM, or ROM extension.

---

getWomTraits

const

retro::vault::RomTraits getWomTraits() const

Defined in VAmiga.h:984

Returns the traits of the installed WOM (see getRomTraits()).

---

getExtTraits

const

retro::vault::RomTraits getExtTraits() const

Defined in VAmiga.h:986

Returns the traits of the installed ROM extension (see getRomTraits()).

---

loadRom

void loadRom(const std::filesystem::path & path)

Defined in VAmiga.h:997

Loads a ROM from a file The ROM type is determined automatically.

Exceptions

Exception	Description
Error	if the file cannot be read or does not contain valid data.

---

loadRom

void loadRom(const u8 * buf, isize len)

Defined in VAmiga.h:1013

Loads a ROM provided by a memory buffer.

Exceptions

Exception	Description
Error	if the data is not valid.

---

loadExt

void loadExt(const std::filesystem::path & path)

Defined in VAmiga.h:999

Loads a ROM extension from a file (see loadRom()).

---

loadExt

void loadExt(const u8 * buf, isize len)

Defined in VAmiga.h:1015

Loads a ROM extension from a memory buffer (see loadRom()).

---

loadRomAsync

void loadRomAsync(const std::filesystem::path & path)

Defined in VAmiga.h:1005

Asynchronous version of loadRom() and loadExt(): queues the request and returns at once.

Success and failure are both reported by a ROM_LOADED message. If the request failed, the message carries the exception.

---

loadExtAsync

void loadExtAsync(const std::filesystem::path & path)

Defined in VAmiga.h:1007

Asynchronous version of loadExt(): queues the request and returns at once.

---

saveRom

void saveRom(const std::filesystem::path & path)

Defined in VAmiga.h:1021

Saves a Rom to disk.

Exceptions

Exception	Description
Error	if the file cannot be written.

---

saveWom

void saveWom(const std::filesystem::path & path)

Defined in VAmiga.h:1023

Saves the WOM to disk (see saveRom()).

---

saveExt

void saveExt(const std::filesystem::path & path)

Defined in VAmiga.h:1025

Saves the ROM extension to disk (see saveRom()).

---

deleteRom

void deleteRom()

Defined in VAmiga.h:1029

Removes a ROM.

---

deleteWom

void deleteWom()

Defined in VAmiga.h:1031

Removes the WOM (see deleteRom()).

---

deleteExt

void deleteExt()

Defined in VAmiga.h:1033

Removes the ROM extension (see deleteRom()).