OpenSNES
Modern Open-Source SNES Development SDK
Loading...
Searching...
No Matches
mosaic.h
Go to the documentation of this file.
1
20
21#ifndef OPENSNES_MOSAIC_H
22#define OPENSNES_MOSAIC_H
23
24#include <snes/types.h>
25#include <snes/registers.h> /* REG_MOSAIC for the inline mosaicInit body */
26
27/* Removed on 2026-10-05 (1.0 plan, lot C): mosaicEnable.
28 * The replacements are in docs/UPGRADING.md; `make check-upgrade` names them. */
29
30/*============================================================================
31 * Background Mask Constants
32 *============================================================================*/
33
34/* The backgrounds are named by LAYER_BG1..LAYER_BG4 (video.h), the same
35 * bits everywhere a call takes a set of layers. */
36#define MOSAIC_BG_ALL 0x0F
37
38/* MOSAIC_BG1..MOSAIC_BG4 were removed on 2026-10-05: use LAYER_BG1..LAYER_BG4
39 * (video.h), the same values (docs/UPGRADING.md). */
40
41/*============================================================================
42 * Mosaic Size Constants
43 *============================================================================*/
44
45#define MOSAIC_MIN 0
46#define MOSAIC_MAX 15
47
48/*============================================================================
49 * Function Declarations
50 *============================================================================*/
51
57void mosaicInit(void);
58
76void mosaicSetLayers(u8 bgMask);
77
81void mosaicDisable(void);
82
92void mosaicSetSize(u8 size);
93
100
116void mosaicFadeIn(u8 speed);
117
134void mosaicFadeOut(u8 speed);
135
136#endif /* OPENSNES_MOSAIC_H */
unsigned char u8
8-bit unsigned integer (0 to 255)
Definition types.h:47
void mosaicSetSize(u8 size)
Set mosaic pixel block size.
u8 mosaicGetSize(void)
Get current mosaic size.
void mosaicInit(void)
Initialize mosaic system.
void mosaicFadeIn(u8 speed)
Animate mosaic fade in (pixelated -> clear).
void mosaicFadeOut(u8 speed)
Animate mosaic fade out (clear -> pixelated).
void mosaicDisable(void)
Disable mosaic effect for all backgrounds.
void mosaicSetLayers(u8 bgMask)
Set the backgrounds the mosaic applies to — REPLACES the previous set.
SNES Hardware Register Definitions.
OpenSNES Standard Types.