SIDAPI

#include <VirtualC64.h>

class SIDAPI

Defined in VirtualC64.h:547

SID Public API

Public Methods

Return	Name	Description
float	draw const	Draws the waveform of a SID chip or of the audio output.
const SIDInfo &	getInfo const	Returns the current state of a specific SID.
const SIDInfo &	getCachedInfo const	Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).

---

draw

const

float draw(u32 * buffer, isize width, isize height, float maxAmp, u32 color, isize sid = -1) const

Defined in VirtualC64.h:590

Draws the waveform of a SID chip or of the audio output.

The waveform is plotted into a texture buffer. The function returns the highest amplitude found. To implement auto-scaling, pass the returned value as parameter 'maxAmp' in the next call.

Returns

The highest amplitude that was found.

Parameters

Parameter	Type	Description
buffer	u32 *	Texture buffer of size width * height
width	isize	Width of the texture in pixels
height	isize	Height of the texture in pixels
maxAmp	float	Amplitude that is mapped to the full height
color	u32	Color of the waveform
sid	isize	Number of the SID chip (0 - 3). Any other value draws the stereo audio output, with the left channel in the upper and the right channel in the lower half.

---

getInfo

const

const SIDInfo & getInfo(isize nr) const

Defined in VirtualC64.h:567

Returns the current state of a specific SID.

getInfo() reads the live state on the calling thread and 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.

Parameters

Parameter	Type	Description
nr	isize	SID number (0 - 3). 0 is the primary SID.

Exceptions

Exception	Description
CoreError	(CoreError::OPT_INV_ARG) if the SID number is out of range.

---

getCachedInfo

const

const SIDInfo & getCachedInfo(isize nr) const

Defined in VirtualC64.h:569

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