Library Reference — Comprehensive Function Documentation

This section contains per-function reference documentation for the major Amiga system libraries, derived from the official AmigaOS NDK 3.2 Release 4 (Hyperion Entertainment, 2022) autodocs.

Each page in this section documents every public function of one library, with autodoc-format entries (NAME, SYNOPSIS, FUNCTION, INPUTS, OUTPUTS, RESULTS, IMPLEMENTATION, NOTE, EXAMPLE, SEE ALSO). The page is intended as a quick, complete lookup — opposite in spirit to the topical guides in exec/, dos/, intuition/, etc. which give an architectural overview.

Conventions used in this section

  • Synopsis block shows both the 68k register convention (D0, A1, etc.) and the modern C signature.
  • Function body text is the verbatim autodoc prose from the NDK 3.2 R4 source databases.
  • Inputs / Outputs / Results list parameters and return values.
  • Implementation notes (when present) describe internal behaviour.
  • Note flags exceptions and gotchas.
  • Example blocks contain C code samples drawn from the autodoc itself.
  • See also lists cross-references to related functions, both within and across libraries.

Version markers (V36 = OS 2.0, V39 = OS 3.0, V40 = OS 3.5, V45 = OS 3.9, V50 = OS 4.0) are preserved from the source.

Type definitions

The library reference pages link to a centralised type definitions reference, extracted from NDK 3.2 R4 header files. Clicking on a struct name in any function synopsis takes you to its C definition.

Library Types page Count
exec types-exec.md (see page)
dos types-dos.md (see page)
intuition types-intuition.md (see page)
graphics types-graphics.md (see page)
hardware types-hardware.md (see page)
utility types-utility.md (see page)

Each types page lists every struct, union, and enum defined in that library's NDK header files, with the verbatim C definition in a fenced code block.

Source

All pages in this section are sourced from the official AmigaOS NDK 3.2 Release 4 (Hyperion Entertainment, 2022):

  • Archive: inbox/mtyysaae_NDK3.2R4.lha (8.1 MB)
  • Format: AmigaGuide database files in Autodocs/AG/<library> (one file per library)
  • Parser: /tmp/ndk_converter.py — extracts @Node sections, @{b} HEADER @{ub} section markers, strips @{...} link markup

Earlier versions of these pages (from Amiga Developer CD v2.1 autodocs) were replaced in commit 9b9554d. The NDK 3.2 R4 source is preferred because: - It documents OS 3.5 / 3.9 / 4.x conventions (V40+ functions) - It has been maintained by Hyperion Entertainment for the modern AmigaOS ecosystem - It cross-references modern include files (<dos/dos.h> vs <libraries/dos.h>)

Cross-references

The wiki has two complementary views of each library:

  1. Topical guides (in exec/, dos/, intuition/, graphics/, gadtools/, etc.) — architectural narrative, idiomatic patterns, modern NDK 3.x conventions, OS 3.9/4.x notes.
  2. Per-function reference (this section) — exhaustive function-by-function documentation following the autodoc structure.

If you want to learn how to use a library, start with the topical guide. If you want to look up what a specific function does, what it takes, what it returns, come here.

Libraries covered

Core system libraries

Library Functions Page
exec.library 115 exec-library.md
dos.library 161 dos-library.md
intuition.library 123 intuition-library.md
graphics.library 166 graphics-library.md
layers.library 38 layers-library.md
utility.library 43 utility-library.md

GUI toolkits and high-level libraries

Library Functions Page
gadtools.library 21 gadtools-library.md
asl.library 5 asl-library.md
commodities.library 26 commodities-library.md
datatypes.library 30 datatypes-library.md
iffparse.library 40 iffparse-library.md
diskfont.library 14 diskfont-library.md
keymap.library 4 keymap-library.md
rexxsyslib.library 17 rexxsyslib-library.md
icon.library 24 icon-library.md
expansion.library 18 expansion-library.md
wb.library (workbench) 16 wb-library.md
locale.library 14 locale-library.md

Low-level and infrastructure

Library Functions Page
lowlevel.library 14 lowlevel-library.md
nonvolatile.library 7 nonvolatile-library.md
realtime.library 10 realtime-library.md
syslog.library (placeholder) syslog-library.md
amigaguide.library 16 amigaguide-library.md
amiga_lib (stub library) 51 amiga_lib-library.md
bullet.library 5 bullet-library.md
debug_lib (debug stubs) 7 debug_lib-library.md
ddebug_lib (debug stubs) 8 ddebug_lib-library.md
misc.resource 2 misc-library.md
filesysres.resource (placeholder) filesysres-library.md

Device libraries

Library Functions Page
audio.device 20 audio-library.md
battclock.resource 3 battclock-library.md
carddisk.device 14 carddisk-library.md
cia.resource 4 cia-library.md
clipboard.device 7 clipboard-library.md
console.device 10 console-library.md
gameport.device 5 gameport-library.md
input.device 10 input-library.md
keyboard.device 6 keyboard-library.md
parallel.device 10 parallel-library.md
potgo.resource 3 potgo-library.md
printer.device 19 printer-library.md
serial.device 14 serial-library.md
timer.device 9 timer-library.md
trackdisk.device 19 trackdisk-library.md
ramdrive.device 12 ramdrive-library.md
scsidisk.device 20 scsidisk-library.md
mfm.device 19 mfm-library.md

Math libraries

Library Functions Page
mathffp.library (FFP, deprecated) 12 mathffp-library.md
mathtrans.library (transcendental) 17 mathtrans-library.md
mathieeedoubbas.library (IEEE double basic) 12 mathieeedoubbas-library.md
mathieeedoubtrans.library (IEEE double trans) 17 mathieeedoubtrans-library.md
mathieeesingbas.library (IEEE single basic) 12 mathieeesingbas-library.md
mathieeesingtrans.library (IEEE single trans) 17 mathieeesingtrans-library.md

Total coverage

  • 54 library / device / resource / class pages
  • ~1300 documented functions across all pages
  • Primary source: AmigaOS NDK 3.2 Release 4 (Hyperion Entertainment, 2022)