Types and Enumerations

Namespaces

Name	Description
`RL`
`Tex`	Emulator texture parameters
`PAL`	PAL related constants
`peddle`
`NTSC`	NTSC related constants
`VICIIColorReg`	Indices of the VICII color registers.

Classes

Name	Description
`AnyFile`	Base class of all media files
`API`	Base class of all APIs
`AudioPortAPI`	Audio Port Public API
`C64API`	C64 API
`CIAAPI`	CIA API
`ControlPortAPI`	Control Port API
`CPUAPI`	CPU API
`CPUDebuggerAPI`	CPU Debugger API
`DatasetteAPI`	Datasette Public API
`DefaultsAPI`	The user's defaults storage
`DiskAPI`	Disk Public API
`DriveAPI`	Drive Public API
`ExpansionPortAPI`	Expansion Port Public API
`GuardsAPI`	Guards API
`JoystickAPI`	Joystick Public API
`KeyboardAPI`	Keyboard Public API
`MemoryAPI`	Memory API
`MemoryDebuggerAPI`	Memory Debugger API
`MouseAPI`	Mouse Public API
`PaddleAPI`	Paddle Public API
`RemoteManagerAPI`	RemoteManager Public API
`RetroShellAPI`	RetroShell Public API
`RS232API`	RS232 Public API
`SerialPortAPI`	Serial Port API
`SIDAPI`	SID Public API
`Snapshot`	A snapshot of the emulator state
`UserPortAPI`	User Port API
`VICIIAPI`	VICII API
`VideoPortAPI`	Video Port Public API
`VirtualC64`	Public API
`XRayAPI`	DMA Debugger Public API
`AlarmCmd`	Payload of alarm commands.
`AudioPortConfig`	Configuration of the audio port.
`AudioPortInfo`	State of the audio port (currently carries no data).
`AudioPortMetrics`	Audio statistics.
`C64Config`	Configuration of the C64 component.
`C64Info`	State of the C64 component.
`C64Key`	Representation of a key on the C64 keyboard
`CartridgeInfo`	State of an attached cartridge.
`CartridgeRomInfo`	Description of a cartridge ROM chip.
`CartridgeTraits`	Properties of a cartridge type.
`CIAConfig`	Configuration of a CIA chip.
`CIAInfo`	State of a CIA chip.
`CIAMetrics`	Usage statistics of a CIA chip.
`CIAPortInfo`	State of a CIA port.
`CIATimerInfo`	State of a CIA timer.
`Command`	A command that is fed into the command queue.
`ConfigCmd`	Payload of configuration commands.
`ConfigMsg`	Payload of configuration messages.
`CoordCmd`	Payload of mouse commands.
`CoreError`	Exception thrown if a request does not match the state of the emulator.
`CPUConfig`	Configuration of the CPU.
`CPUInfo`	State of the CPU.
`CpuMsg`	Payload of CPU messages (the program counter).
`DatasetteConfig`	Datasette configuration.
`DatasetteInfo`	Datasette current state.
`DiskLayout`	Layout of a disk.
`DriveConfig`	Configuration of a drive.
`DriveInfo`	State of a drive.
`DriveMsg`	Payload of drive messages.
`EmulatorInfo`	The current emulator state.
`EmulatorMetrics`	Collected run-time data.
`EventSlotInfo`	State of a single event slot.
`ExpansionPortConfig`	Configuration of the expansion port.
`FrameFlipflops`	State of the frame flip-flops.
`GamePadCmd`	Payload of joystick commands.
`Guard`	Base structure for a single breakpoint or watchpoint.
`GuardCmd`	Payload of breakpoint and watchpoint commands.
`GuardInfo`	Description of a breakpoint or watchpoint.
`HostConfig`	Properties of the host machine.
`InputLine`	A line of input for RetroShell.
`JoyStateCmd`	Payload of joystick state commands.
`JoystickConfig`	Configuration of a joystick.
`JoystickInfo`	State of a joystick.
`KeyCmd`	Payload of keyboard commands.
`MediaError`	Exception thrown if a media file is invalid or not supported.
`MemConfig`	Configuration of the memory.
`MemInfo`	State of the memory.
`MemMetrics`	Memory access statistics.
`Message`	A message sent from the emulator to the GUI.
`MonitorConfig`	Configuration of the monitor emulation.
`MouseConfig`	Configuration of a mouse.
`PaddleConfig`	Configuration of a paddle.
`PaddleInfo`	State of a paddle (currently carries no data).
`PowerPortConfig`	Configuration of the power port.
`RemoteManagerInfo`	State of the remote servers.
`RemoteServerInfo`	State of a remote server.
`RetroShellInfo`	State of RetroShell.
`RomInfo`	Description of an installed ROM.
`RS232Config`	Configuration of the RS232 adapter.
`ScriptMsg`	Payload of script messages.
`SectorLayout`	Position of a sector on a track (in bits).
`ServerConfig`	Configuration of a remote server.
`SIDConfig`	Configuration of a SID chip.
`SIDInfo`	State of a SID chip.
`SnapshotHeader`	Header of a snapshot.
`SnapshotMsg`	Payload of snapshot messages.
`SpriteInfo`	State of a sprite.
`TapeCmd`	Payload of tape commands.
`Thumbnail`	Preview image of a snapshot.
`TODInfo`	State of the time-of-day clock.
`TrackDefaults`	Default properties of a track.
`TrackLayout`	Layout of a track.
`TrafficEntry`	An entry of the traffic log.
`UserPortConfig`	Configuration of the user port.
`UserPortInfo`	State of the user port (currently carries no data).
`VICIIConfig`	Configuration of the VICII chip.
`VICIIInfo`	State of the VICII chip.
`VICIIMetrics`	Performance statistics of the graphics synthesizer.
`VICIITraits`	Properties of a VICII chip revision.
`VideoPortConfig`	Configuration of the video port.
`VideoPortInfo`	State of the video port.
`VideoPortStats`	Statistics of the video port.
`VoiceInfo`	State of a SID voice.
`vspace`	Vertical spacing, used in operator overloads.
`XRayConfig`	Configuration of the X-Ray visualizer.
`TimeOfDay`	Time-of-day value in BCD format.

Enumerations

Name	Description
`ConfigScheme`	C64 model.
`Warp`	Warp mode selection.
`EventSlot`	Slots of the event scheduler.
`EventID`	Events that can be scheduled in the event slots.
`CIARev`	Chip revision.
`CIAReg`	Registers of a CIA chip.
`DasmNumbers`
`GuardType`
`MemType`	Memory type.
`RamPattern`	Ram startup pattern.
`SIDRevision`	Chip revision.
`SIDEngine`	SID backend.
`SamplingMethod`	Sampling method of the reSID engine.
`MemAccess`	Types of VICII memory accesses.
`VICIIRev`	VICII chip revision.
`GlueLogic`	Glue logic implementation.
`ScreenGeometry`	C64 canvas size.
`DisplayMode`	C64 display mode.
`ColorSource`	Source of a pixel color in the graphics synthesizer.
`VICIIColor`	The 16 colors of the VICII chip.
`XRayMode`	X-Ray mode.
`XRayCompositor`	Who merges the X-Ray texture into the emulator texture.
`DmaDisplayMode`	DMA debugger display mode.
`Cmd`	Emulator command.
`Class`
`DebugFlag`	Flags for enabling debug output.
`TexFormat`	Byte layout of a 32-bit host pixel.
`Msg`	Emulator message.
`Opt`	Configuration option.
`ExecState`	Execution state.
`CartridgeType`	Supported cartridge types.
`FlashState`	State of a flash ROM chip.
`FileType`	Supported media file types.
`TAPVersion`	Version of the TAP file format.
`FileError`	Error codes for file operations.
`ServerType`
`TrafficDirection`	Direction of a packet in the traffic log.
`CommandSet`	Command sets of RetroShell.
`RSKey`	RetroShell special key.
`DatasetteModel`	Datasette model.
`DriveType`	Drive model.
`DriveRam`	Memory expansion of a drive.
`DrvMemType`	Memory types of a drive.
`InsertionStatus`	Insertion state of a disk.
`DiskType`	Disk type.
`CBMFileType`
`ParCableType`	Parallel cable type.
`GamePadAction`	Gamepad / Joystick event.
`Palette`	Color palette.
`Upscaler`	Pixel upscaler.
`Dotmask`	Dotmask.
`Scanlines`	Scanlines.
`MouseModel`	Mouse model.
`CommunicationDevice`	Devices that can be connected to the RS232 adapter.
`PaddleOrientation`	Value mapping scheme.
`ControlPortDevice`	Control port device.
`CRTMode`	Cartridge mode.
`PowerGrid`	Power grip characteristics.
`UserPortDevice`

Typedefs

Return	Name	Description
`i64`	`Cycle`	Emulator time in master clock cycles.
`u32`	`RunLoopFlags`	Flags that are set to request actions of the run loop.
`utl::RingBuffer< short, 2048 >`	`SampleStream`	Buffer for audio samples.
`void`	`Callback`	Signature of the function that receives messages.
`isize`	`Cylinder`	Cylinder number.
`isize`	`Head`	Head number.
`isize`	`Track`	Track number.
`isize`	`Halftrack`	Halftrack number.
`isize`	`Sector`	Sector number.
`isize`	`Block`	Block number.
`isize`	`HeadPos`	Position of the drive head within a halftrack (in bits).

Cycle

cpp

using Cycle = i64

Defined in Components/C64Types.h:26

Emulator time in master clock cycles.

RunLoopFlags

cpp

using RunLoopFlags = u32

Defined in Components/C64Types.h:373

Flags that are set to request actions of the run loop.

SampleStream

cpp

using SampleStream = utl::RingBuffer< short, 2048 >

Defined in Components/SID/SIDTypes.h:26

Buffer for audio samples.

Callback

cpp

using Callback = void

Defined in Infrastructure/MsgQueueTypes.h:294

Signature of the function that receives messages.

Cylinder

cpp

using Cylinder = isize

Defined in Peripherals/Drive/DriveTypes.h:25

Cylinder number.

Head

cpp

using Head = isize

Defined in Peripherals/Drive/DriveTypes.h:27

Head number.

Track

cpp

using Track = isize

Defined in Peripherals/Drive/DriveTypes.h:29

Track number.

Halftrack

cpp

using Halftrack = isize

Defined in Peripherals/Drive/DriveTypes.h:31

Halftrack number.

Sector

cpp

using Sector = isize

Defined in Peripherals/Drive/DriveTypes.h:33

Sector number.

Block

cpp

using Block = isize

Defined in Peripherals/Drive/DriveTypes.h:35

Block number.

HeadPos

cpp

using HeadPos = isize

Defined in Peripherals/Drive/DriveTypes.h:37

Position of the drive head within a halftrack (in bits).

Functions

Return	Name	Description
`bool`	`isTrackNumber` `static` `inline`
`bool`	`isHalftrackNumber` `static` `inline`
`bool`	`isSectorNumber` `static` `inline`

isTrackNumber

static inline

cpp

static inline bool isTrackNumber(isize nr)

Defined in Peripherals/Drive/FloppyDiskTypes.h:50

isHalftrackNumber

static inline

cpp

static inline bool isHalftrackNumber(isize nr)

Defined in Peripherals/Drive/FloppyDiskTypes.h:51

isSectorNumber

static inline

cpp

static inline bool isSectorNumber(isize nr)

Defined in Peripherals/Drive/FloppyDiskTypes.h:52

Variables

Return	Name	Description
`int`	`INTSRC_CIA` `constexpr`
`int`	`INTSRC_VIC` `constexpr`
`int`	`INTSRC_VIA1` `constexpr`
`int`	`INTSRC_VIA2` `constexpr`
`int`	`INTSRC_EXP` `constexpr`
`int`	`INTSRC_KBD` `constexpr`
`isize`	`XRAY_COLOR_COUNT` `constexpr`	X-Ray mode Number of persisted Opt::XRAY_COLORn slots
`const isize`	`DRIVE8` `static`	Number of drive 8.
`const isize`	`DRIVE9` `static`	Number of drive 9.
`const isize`	`highestTrack` `static`
`const isize`	`highestHalftrack` `static`
`const isize`	`highestSector` `static`	Highest sector number (numbering starts with 0).
`const isize`	`maxBytesOnTrack` `static`
`const isize`	`maxBitsOnTrack` `static`
`const i64`	`averageBitTimeSpan` `static`
`const isize`	`averageBitsOnTrack` `static`
`const isize`	`averageBytesOnTrack` `static`
`const isize`	`headerBlockSize` `static`
`const isize`	`dataBlockSize` `static`
`auto`	`PORT_1` `static` `constexpr`	Control port 1.
`auto`	`PORT_2` `static` `constexpr`	Control port 2.

INTSRC_CIA

constexpr

cpp

int INTSRC_CIA = 0b00000001

Defined in Components/CPU/CPUTypes.h:24

INTSRC_VIC

constexpr

cpp

int INTSRC_VIC = 0b00000010

Defined in Components/CPU/CPUTypes.h:25

INTSRC_VIA1

constexpr

cpp

int INTSRC_VIA1 = 0b00000100

Defined in Components/CPU/CPUTypes.h:26

INTSRC_VIA2

constexpr

cpp

int INTSRC_VIA2 = 0b00001000

Defined in Components/CPU/CPUTypes.h:27

INTSRC_EXP

constexpr

cpp

int INTSRC_EXP = 0b00010000

Defined in Components/CPU/CPUTypes.h:28

INTSRC_KBD

constexpr

cpp

int INTSRC_KBD = 0b00100000

Defined in Components/CPU/CPUTypes.h:29

XRAY_COLOR_COUNT

constexpr

cpp

isize XRAY_COLOR_COUNT = 11

Defined in Components/VICII/XRayTypes.h:26

X-Ray mode Number of persisted Opt::XRAY_COLORn slots

DRIVE8

static

cpp

const isize DRIVE8 = 0

Defined in Peripherals/Drive/DriveTypes.h:45

Number of drive 8.

DRIVE9

static

cpp

const isize DRIVE9 = 1

Defined in Peripherals/Drive/DriveTypes.h:47

Number of drive 9.

highestTrack

static

cpp

const isize highestTrack = 42

Defined in Peripherals/Drive/FloppyDiskTypes.h:44

highestHalftrack

static

cpp

const isize highestHalftrack = 84

Defined in Peripherals/Drive/FloppyDiskTypes.h:45

highestSector

static

cpp

const isize highestSector = 20

Defined in Peripherals/Drive/FloppyDiskTypes.h:48

Highest sector number (numbering starts with 0).

maxBytesOnTrack

static

cpp

const isize maxBytesOnTrack = 7928

Defined in Peripherals/Drive/FloppyDiskTypes.h:59

maxBitsOnTrack

static

cpp

const isize maxBitsOnTrack = maxBytesOnTrack * 8

Defined in Peripherals/Drive/FloppyDiskTypes.h:60

averageBitTimeSpan

static

cpp

const i64 averageBitTimeSpan[]

Defined in Peripherals/Drive/FloppyDiskTypes.h:67

averageBitsOnTrack

static

cpp

const isize averageBitsOnTrack[4]

Defined in Peripherals/Drive/FloppyDiskTypes.h:79

averageBytesOnTrack

static

cpp

const isize averageBytesOnTrack[4]

Defined in Peripherals/Drive/FloppyDiskTypes.h:90

headerBlockSize

static

cpp

const isize headerBlockSize = 10 * 8

Defined in Peripherals/Drive/FloppyDiskTypes.h:101

dataBlockSize

static

cpp

const isize dataBlockSize = 325 * 8

Defined in Peripherals/Drive/FloppyDiskTypes.h:102

PORT_1

static constexpr

cpp

auto PORT_1 = 0

Defined in Ports/ControlPortTypes.h:25

Control port 1.

PORT_2

static constexpr

cpp

auto PORT_2 = 1

Defined in Ports/ControlPortTypes.h:27

Control port 2.

Types and Enumerations ​

Namespaces ​

Classes ​

Enumerations ​

Typedefs ​

Cycle ​

RunLoopFlags ​

SampleStream ​

Callback ​

Cylinder ​

Head ​

Track ​

Halftrack ​

Sector ​

Block ​

HeadPos ​

Functions ​

isTrackNumber ​

isHalftrackNumber ​

isSectorNumber ​

Variables ​

INTSRC_CIA ​

INTSRC_VIC ​

INTSRC_VIA1 ​

INTSRC_VIA2 ​

INTSRC_EXP ​

INTSRC_KBD ​

XRAY_COLOR_COUNT ​

DRIVE8 ​

DRIVE9 ​

highestTrack ​

highestHalftrack ​

highestSector ​

maxBytesOnTrack ​

maxBitsOnTrack ​

averageBitTimeSpan ​

averageBitsOnTrack ​

averageBytesOnTrack ​

headerBlockSize ​

dataBlockSize ​

PORT_1 ​

PORT_2 ​

Types and Enumerations

Namespaces

Classes

Enumerations

Typedefs

Cycle

RunLoopFlags

SampleStream

Callback

Cylinder

Head

Track

Halftrack

Sector

Block

HeadPos

Functions

isTrackNumber

isHalftrackNumber

isSectorNumber

Variables

INTSRC_CIA

INTSRC_VIC

INTSRC_VIA1

INTSRC_VIA2

INTSRC_EXP

INTSRC_KBD

XRAY_COLOR_COUNT

DRIVE8

DRIVE9

highestTrack

highestHalftrack

highestSector

maxBytesOnTrack

maxBitsOnTrack

averageBitTimeSpan

averageBitsOnTrack

averageBytesOnTrack

headerBlockSize

dataBlockSize

PORT_1

PORT_2