alchemy-docs/runtime_8c_source.html

/// @file

/// The runtime object: what every other part of the game stands on. Power-up

/// and the interrupt handlers, the frame wait and VBlank, input, the register

/// write queue, fades, the sprite lists and VRAM cache, the task scheduler,

/// maths, debug text, the heap, the 3D transform, saving and the link cable.

///

/// runtime_internal.h holds what every part shares (its includes); the code

/// is in the files under runtime/, included here in the order it has in the

/// ROM. Camelot's own files are not recoverable: the ROM shows one object, and

/// these parts are ours, cut where one family ends and the next begins.

/// README.md in this folder gives the words and prefixes the parts use. Where

/// to start:

///

///   Power-up        system.c: System_Initialize

///   Frames          frame.c: WaitFrames, System_VBlankHandler,

///                   Runtime_SetIrqHandler; scheduler.c:

///                   Scheduler_AddOrUpdateCallback

///   Screen          fade.c: Fade_Start; render.c: Render_BuildOamList;

///                   vram_cache.c: VramCache_Load

///   Memory          heap.c: Runtime_AllocateHeapBlock, MemAlloc

///   3D              transform.c: SceneTransform_ApplyRotationTranslation,

///                   Render_ProjectPoint

///   Saving          save.c: SaveState_WriteRecord,

///                   SaveState_ReadRecordPayload

///   Link cable      serial.c: SerialRuntime_Initialize,

///                   SerialRuntime_ExchangePayloads


#include "runtime_internal.h"


// The runtime object's code, in ROM order. Each part is compiled here, as

// part of this one object, never on its own: the order of these includes is

// the order of the code in the ROM.

#include "runtime/system.c"

#include "runtime/frame.c"

#include "runtime/io_queue.c"

#include "runtime/fade.c"

#include "runtime/render.c"

#include "runtime/vram_cache.c"

#include "runtime/scheduler.c"

#include "runtime/math.c"

#include "runtime/text.c"

#include "runtime/heap.c"

#include "runtime/transform.c"

#include "runtime/decompress.c"

#include "runtime/save.c"

#include "runtime/serial.c"

fade.c
Screen fades through the blend registers.

frame.c
Interrupt handlers, the frame wait, key repeat and the VBlank handler.

heap.c
The heap: its two bump allocators and named slots.

io_queue.c
The register write queue that VBlank carries out after each finished frame.

math.c
Random numbers, angles and square roots.

render.c
The frame's sprite lists: affine matrices, depth slots and the OAM build.

decompress.c
Resource decoding and pixel buffer shading, through RAM copies of ARM code.

save.c
Saving: flash sectors, records and the save workspace.

runtime_internal.h
What every part of the runtime object shares: its includes and the library call two parts make.

scheduler.c
The task scheduler: per-frame and VBlank routines in order.

serial.c
The link cable: payload exchange, block transfers and the link test.

system.c
Power-up, the cartridge's language, the build stamp and code loading.

text.c
Number text, the debug text screen and the window graphics.

transform.c
The 3D transform, its stack, the look-at matrix and the projection.

vram_cache.c
The sprite VRAM cache: blocks, entries and loading pictures.