vAmiga

Appearance

XRayAPI ​

cpp
#include <VAmiga.h>
cpp
class XRayAPI

Defined in VAmiga.h:368

API of the X-Ray visualizer.

Public Methods ​

ReturnNameDescription
const XRayConfig &getConfig constReturns the component's current configuration.
const XRayInfo &getInfo constReturns the component's current state.
const XRayInfo &getCachedInfo constReturns the most recent state snapshot recorded by the emulator thread (see getInfo()).

getConfig ​

const

cpp
const XRayConfig & getConfig() const

Defined in VAmiga.h:378

Returns the component's current configuration.

getInfo ​

const

cpp
const XRayInfo & getInfo() const

Defined in VAmiga.h:389

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

cpp
const XRayInfo & getCachedInfo() const

Defined in VAmiga.h:391

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