Loading...
Searching...
No Matches
background.h
Go to the documentation of this file.
1
17#ifndef OPENSNES_BACKGROUND_H
18#define OPENSNES_BACKGROUND_H
19
20#include <snes/types.h>
21
22/*============================================================================
23 * Constants
24 *============================================================================*/
25
30#define BG_MAP_32x32 0
31#define BG_MAP_64x32 1
32#define BG_MAP_32x64 2
33#define BG_MAP_64x64 3
35/* PVSnesLib compatibility aliases */
36#define SC_32x32 BG_MAP_32x32
37#define SC_64x32 BG_MAP_64x32
38#define SC_32x64 BG_MAP_32x64
39#define SC_64x64 BG_MAP_64x64
46#define BG_4COLORS 4
47#define BG_16COLORS 16
48#define BG_256COLORS 256
50/* Mode 0 has separate subpalettes */
51#define BG_4COLORS0 1
54/*============================================================================
55 * Scrolling
56 *============================================================================*/
57
70void bgSetScroll(u8 bg, u16 x, u16 y);
71
78void bgSetScrollX(u8 bg, u16 x);
79
86void bgSetScrollY(u8 bg, u16 y);
87
94u16 bgGetScrollX(u8 bg);
95
102u16 bgGetScrollY(u8 bg);
103
104/*============================================================================
105 * Memory Configuration
106 *============================================================================*/
107
126void bgSetMapPtr(u8 bg, u16 vramAddr, u8 mapSize);
127
144void bgSetGfxPtr(u8 bg, u16 vramAddr);
145
153void bgInit(u8 bg);
154
155/*============================================================================
156 * Combined Initialization (PVSnesLib compatible)
157 *============================================================================*/
158
180void bgInitTileSet(u8 bgNumber, u8 *tileSource, u8 *tilePalette,
181 u8 paletteEntry, u16 tileSize, u16 paletteSize,
182 u16 colorMode, u16 vramAddr);
183
192void bgInitTileSetData(u8 bgNumber, u8 *tileSource, u16 tileSize, u16 vramAddr);
193
194/*============================================================================
195 * Tilemap Utilities
196 *============================================================================*/
197
216#define bgClearTilemap(vramAddr, fillTile, sizeBytes) \
217 dmaFillVRAM((u16)(fillTile), (u16)(vramAddr), (u16)(sizeBytes))
218
219#endif /* OPENSNES_BACKGROUND_H */
bgInitTileSet
void bgInitTileSet(u8 bgNumber, u8 *tileSource, u8 *tilePalette, u8 paletteEntry, u16 tileSize, u16 paletteSize, u16 colorMode, u16 vramAddr)
Initialize tileset with tiles and palette.
bgSetMapPtr
void bgSetMapPtr(u8 bg, u16 vramAddr, u8 mapSize)
Set background tilemap address and size.
bgSetScrollY
void bgSetScrollY(u8 bg, u16 y)
Set vertical scroll only.
bgSetScrollX
void bgSetScrollX(u8 bg, u16 x)
Set horizontal scroll only.
bgGetScrollY
u16 bgGetScrollY(u8 bg)
Get current vertical scroll position (from shadow)
bgSetGfxPtr
void bgSetGfxPtr(u8 bg, u16 vramAddr)
Set background tile graphics address.
bgSetScroll
void bgSetScroll(u8 bg, u16 x, u16 y)
Set background scroll position.
bgInitTileSetData
void bgInitTileSetData(u8 bgNumber, u8 *tileSource, u16 tileSize, u16 vramAddr)
Load tile graphics only (no palette)
bgGetScrollX
u16 bgGetScrollX(u8 bg)
Get current horizontal scroll position (from shadow)
bgInit
void bgInit(u8 bg)
Initialize background layer to defaults.
u16
unsigned short u16
16-bit unsigned integer (0 to 65535)
Definition types.h:52
u8
unsigned char u8
8-bit unsigned integer (0 to 255)
Definition types.h:46
types.h
OpenSNES Standard Types.