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) |
mui |
types-mui.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@Nodesections,@{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:
- Topical guides (in
exec/,dos/,intuition/,graphics/,gadtools/, etc.) — architectural narrative, idiomatic patterns, modern NDK 3.x conventions, OS 3.9/4.x notes. - 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 |
battmem.resource |
4 | battmem-library.md |
disk.resource |
6 | disk-library.md |
rexxsupport.library |
23 | rexxsupport-library.md |
system-startup |
(narrative) | system-startup-library.md |
Device libraries¶
| Library | Functions | Page |
|---|---|---|
audio.device |
20 | audio-library.md |
battclock.resource |
3 | battclock-library.md |
card.resource |
17 | card-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 |
Third-party libraries (MUI 3.8 dev)¶
| Library | Functions | Page |
|---|---|---|
muimaster.library (MUI engine) |
18 | muimaster-library.md |
mui.library (C wrapper) |
1 | mui-library.md |
| MUI classes (65 BOOPSI classes) | — | mui-classes/index.md |
ReAction BOOPSI classes¶
The standard AmigaOS BOOPSI gadget/image/class hierarchy shipped with OS 3.x (and extended in later versions). Each page documents the public methods, attributes, and class-specific functions of one class.
| Class | Methods | Page |
|---|---|---|
arexx.class |
3 | arexx-class-library.md |
chooser.gadget |
6 | chooser-gadget-library.md |
clicktab.gadget |
5 | clicktab-gadget-library.md |
colorwheel.gadget |
2 | colorwheel-gadget-library.md |
datebrowser.gadget |
4 | datebrowser-gadget-library.md |
layout.gadget |
9 | layout-gadget-library.md |
listbrowser.gadget |
19 | listbrowser-gadget-library.md |
radio.gadget |
5 | radio-gadget-library.md |
requester.class |
2 | requester-class-library.md |
scroller.gadget |
2 | scroller-gadget-library.md |
sketchboard.gadget |
5 | sketchboard-gadget-library.md |
slider.gadget |
1 | slider-gadget-library.md |
speedbar.gadget |
5 | speedbar-gadget-library.md |
texteditor.gadget |
38 | texteditor-gadget-library.md |
virtual.gadget |
3 | virtual-gadget-library.md |
window.class |
8 | window-class-library.md |
Simple gadget classes (BOOPSI GetClass only)¶
| Class | Page |
|---|---|
button.gadget |
button-gadget-library.md |
checkbox.gadget |
checkbox-gadget-library.md |
fuelgauge.gadget |
fuelgauge-gadget-library.md |
getcolor.gadget |
getcolor-gadget-library.md |
getfile.gadget |
getfile-gadget-library.md |
getfont.gadget |
getfont-gadget-library.md |
getscreenmode.gadget |
getscreenmode-gadget-library.md |
gradientslider.gadget |
gradientslider-gadget-library.md |
integer.gadget |
integer-gadget-library.md |
listview.gadget |
listview-gadget-library.md |
palette.gadget |
palette-gadget-library.md |
space.gadget |
space-gadget-library.md |
string.gadget |
string-gadget-library.md |
tabs.gadget |
tabs-gadget-library.md |
tapedeck.gadget |
tapedeck-gadget-library.md |
BOOPSI image classes¶
| Class | Page |
|---|---|
bevel.image |
bevel-image-library.md |
bitmap.image |
bitmap-image-library.md |
boingball.image |
boingball-image-library.md |
drawlist.image |
drawlist-image-library.md |
glyph.image |
glyph-image-library.md |
label.image |
label-image-library.md |
led.image |
led-image-library.md |
penmap.image |
penmap-image-library.md |
BOOPSI datatype classes¶
| Class | Page |
|---|---|
8svx.datatype |
8svx-datatype-library.md |
acbm.datatype |
acbm-datatype-library.md |
amigaguide.datatype |
amigaguide-datatype-library.md |
animation.datatype |
animation-datatype-library.md |
anim.datatype |
anim-datatype-library.md |
ascii.datatype |
ascii-datatype-library.md |
bmp.datatype |
bmp-datatype-library.md |
cdxl.datatype |
cdxl-datatype-library.md |
ilbm.datatype |
ilbm-datatype-library.md |
picture.datatype |
picture-datatype-library.md |
sound.datatype |
sound-datatype-library.md |
text.datatype |
text-datatype-library.md |
wav.datatype |
wav-datatype-library.md |
Total coverage¶
- 113 library / device / resource / class pages
- ~1700 documented functions across all pages
- Primary source: AmigaOS NDK 3.2 Release 4 (Hyperion Entertainment, 2022)