 |
OpenSNES
Modern Open-Source SNES Development SDK
|
|
OpenSNES
Modern Open-Source SNES Development SDK
|
The releases up to 0.48 deprecate; 0.49 removes, so that 1.0 has nothing left to remove. Every name below built with a warning in 0.48 (the clang pre-pass reported each use; without clang the build ran the same scan in Python on each source it compiled) and is gone at 0.49: a project that names one no longer compiles, and opensnes upgrade <folder> reads a whole project against the list and says what to use. This is the API 1.0 is expected to freeze (docs/STABILITY.md).
State at 0.49.0 (2026-10-10; the removals date from 2026-10-05): the constants of section 3, the OAM_SET_GFX_BANK macro and the twenty-six renamed functions of section 2 are gone from the headers, opensnes upgrade reports each use from make/removed_api.txt, hdmaEnable() / hdmaDisable() take a channel number and dmaTransfer() a far pointer (section 1). No OPENSNES_DEPRECATED declaration is left.
Two things on this page are not removals but changes of meaning: read them first. Everything else is a rename where the old and new name do the same thing.
Until 0.48 they took a bit mask (1 << channel), like nothing else in hdma.h. Since 0.48 that meaning has its own names, hdmaEnableMask() and hdmaDisableMask(), and in 0.48 the two short names warn. At 0.49 (on develop since 2026-10-05) they take a channel number 0-7, like the other twenty functions of the header. A call left as hdmaEnable(0x40) compiles and means something else; values above 7 are refused (nothing is enabled), so 0x40, 0x0F, 0xFF and 1 << 6 fail visibly, but the masks 1, 2 and 4 silently become channels 1, 2 and 4 instead of 0, 1 and 2.
Until 0.48 the generic transfer took the bank and the 16-bit address as two arguments; since 0.49 the source is a const u8 *, whose bank byte the function reads, like every dmaCopy* helper. A six-argument call no longer compiles (one argument too many), so nothing changes silently.
Before 0.47 the helpers divided the scale by two: 0x0100 magnified twice and 0x0200 was 1:1. A project that passed 0x0200 for a 1:1 view sees its plane shrink; pass 0x0100. mode7Transform(deg, 100) is 1:1 too. No warning can catch this one: search your sources for mode7SetScale and mode7Transform.
| Removed at 0.49 | Use instead | Header | Note |
|---|---|---|---|
| rand() | rngNext() | console.h | not libc's rand: 1-65535, a 16-bit LFSR |
| srand(s) | rngSeed(s) | console.h | |
| getRegion() | isPAL() | console.h | the same value, 0 NTSC / 1 PAL |
| consoleInitEx(o) | consoleInit() | console.h | the argument was always ignored |
| profileGetFrameCount() | getFrameCount() | profile.h | the same counter |
| padRaw(p) | padHeld(p) | input.h | never the raw register. One difference: padHeld answers 0 for an unplugged port's $FFFF, padRaw returned the $FFFF |
| scopeButtonsDown() | scopeButtonsHeld() | input.h | "currently down", like padHeld |
| nmiSetBank(f, b) | nmiSet(f) | interrupt.h | the bank comes from the pointer. nmiSet(NULL) disarms; nmiSetBank(NULL, b) installed a jump to nothing |
| irqSetBank(f, b) | irqSet(f) | interrupt.h | idem |
| dmaCopyVramBank(s, b, …) | dmaCopyVram(s, …) | dma.h | idem |
| dmaCopyCGramBank(s, b, …) | dmaCopyCGram(s, …) | dma.h | idem |
| hdmaSetupBank(c, m, r, t, b) | hdmaSetup(c, m, r, t) | hdma.h | idem |
| OAM_SET_GFX_BANK(id, p, b) | OAM_SET_GFX(id, p) | sprite.h | idem (macro) |
| colorMathEnable(l) | colorMathSetLayers(l) | colormath.h | it replaces the set, it never added to it |
| mosaicEnable(m) | mosaicSetLayers(m) | mosaic.h | idem |
| LzssDecodeVram(s, a) | lzssDecodeVram(s, a) | lzss.h | lower-case l |
| sa1Init() | sa1IsReady() | sa1.h | crt0 boots the SA-1; this only read its status |
| dsp1Present() | dsp1IsPresent() | dsp1.h | returns 0 / 1 |
| dsp1Parameter(fx, fy, fz, lfe, les, aas, azs) | dsp1SetCamera(&cam) | dsp1.h | the seven arguments are the fields of Dsp1Camera, in order |
| ease_in_quad(t) / ease_out_quad(t) | easeInQuad(t) / easeOutQuad(t) | math.h | |
| mode7SetPivot(x, y) | mode7SetCenter(x, y) | mode7.h | the same two registers, without the 0-255 limit |
| oamDrawMeta(id, x, y, m, tile, pal, size) | oamDrawMetasprite(id, x, y, m, &style, 0) | sprite.h | tile, pal, size are MetaspriteStyle fields |
| oamDrawMetaFlip(id, x, y, m, tile, pal, size, fx, fy, w, h) | oamDrawMetasprite(id, x, y, m, &style, flip) | sprite.h | style.pieceSize replaces the old function's assumption that a piece is 16 pixels when large and 8 when small (wrong for 32-pixel pieces) |
| audioUpdate() | remove the call | audio.h | it did nothing |
| snesmodSetSoundTable(t) | remove the call | snesmod.h | no SDK call starts a stream; the table was never read |
| snesmodAllocateSoundRegion(n) | remove the call | snesmod.h | idem; it did take memory from the module |
| Removed at 0.49 | Use instead | Header |
|---|---|---|
| BGMODE_MODE0, BGMODE_MODE1, BGMODE_MODE2, BGMODE_MODE3, BGMODE_MODE7 | BG_MODE0 … BG_MODE7 | registers.h → video.h |
| WINDOW_BG1 … WINDOW_BG4, WINDOW_OBJ | LAYER_BG1 … LAYER_BG4, LAYER_OBJ | window.h → video.h |
| COLORMATH_BG1 … COLORMATH_BG4, COLORMATH_OBJ | LAYER_BG1 … LAYER_OBJ | colormath.h → video.h |
| MOSAIC_BG1 … MOSAIC_BG4 | LAYER_BG1 … LAYER_BG4 | mosaic.h → video.h |
What only one module has keeps its name: WINDOW_MATH, WINDOW_ALL, WINDOW_ALL_BG, COLORMATH_BACKDROP, COLORMATH_ALL, MOSAIC_BG_ALL, and the TM_* register bit names of registers.h.
Build it with clang installed: every deprecated name prints a warning naming its replacement. Then search for the two calls that change meaning:
opensnes upgrade <folder> lists every removed name with its replacement, and every hdmaEnable / hdmaDisable / dmaTransfer / mode7SetScale / mode7Transform call, one line per hit (the names are make/removed_api.txt and make/changed_api.txt in the SDK; nothing to install — in the repository, make check-upgrade SRC=<folder> is the same command). Exit 0 when nothing is found. A source that fails to compile gets the removed names it uses, with their replacements, right under the compiler's error.
1.16.1