VirtualC64

Appearance

CIAAPI ​

cpp
#include <VirtualC64.h>
cpp
class CIAAPI

Defined in VirtualC64.h:458

CIA API

Public Methods ​

ReturnNameDescription
const CIAConfig &getConfig constReturns the component's current configuration.
const CIAInfo &getInfo constReturns the component's current state.
const CIAInfo &getCachedInfo constReturns the most recent state snapshot recorded by the emulator thread (see getInfo()).
const CIAMetrics &getMetrics constReturns statistical information about the components.
const CIAMetrics &getCachedMetrics constReturns the most recent metrics snapshot recorded by the emulator thread (see getMetrics()).

getConfig ​

const

cpp
const CIAConfig & getConfig() const

Defined in VirtualC64.h:468

Returns the component's current configuration.

getInfo ​

const

cpp
const CIAInfo & getInfo() const

Defined in VirtualC64.h:479

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 CIAInfo & getCachedInfo() const

Defined in VirtualC64.h:481

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

getMetrics ​

const

cpp
const CIAMetrics & getMetrics() const

Defined in VirtualC64.h:492

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

cpp
const CIAMetrics & getCachedMetrics() const

Defined in VirtualC64.h:494

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