background.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------------
 
    background.h -- definitions for SNES backgrounds
 
    Copyright (C) 2012-2017
        Alekmaul
 
    This software is provided 'as-is', without any express or implied
    warranty.  In no event will the authors be held liable for any
    damages arising from the use of this software.
 
    Permission is granted to anyone to use this software for any
    purpose, including commercial applications, and to alter it and
    redistribute it freely, subject to the following restrictions:
 
    1.  The origin of this software must not be misrepresented; you
    must not claim that you wrote the original software. If you use
    this software in a product, an acknowledgment in the product
    documentation would be appreciated but is not required.
 
    2.  Altered source versions must be plainly marked as such, and
    must not be misrepresented as being the original software.
 
    3.  This notice may not be removed or altered from any source
    distribution.
 
---------------------------------------------------------------------------------*/
#ifndef SNES_BACKGROUND_INCLUDE
#define SNES_BACKGROUND_INCLUDE
 
#include <snes/snestypes.h>
 
#include <snes/dma.h>
#include <snes/interrupt.h>
#include <snes/video.h>
 
#define SC_BASE_SHIFT 2
 
#define SC_TILE_BASE(base) ((base) << SC_BASE_SHIFT)
 
/* Bit defines for the background control registers */
#define SC_32x32 (0 << 0) 
#define SC_64x32 (1 << 0) 
#define SC_32x64 (2 << 0) 
#define SC_64x64 (3 << 0) 
#define BG_MODE0 (0 << 0) 
#define BG_MODE1 (1 << 0) 
#define BG_MODE2 (2 << 0) 
#define BG_MODE3 (3 << 0) 
#define BG_MODE4 (4 << 0) 
#define BG_MODE5 (5 << 0) 
#define BG_MODE6 (6 << 0) 
#define BG_MODE7 (7 << 0) 
#define BG1_TSIZE8x8 (0 << 4)
#define BG2_TSIZE8x8 (0 << 5)
#define BG3_TSIZE8x8 (0 << 6)
#define BG4_TSIZE8x8 (0 << 7)
 
#define BG1_TSIZE16x16 (1 << 4)
#define BG2_TSIZE16x16 (1 << 5)
#define BG3_TSIZE16x16 (1 << 6)
#define BG4_TSIZE16x16 (1 << 7)
 
#define BG1_ENABLE (1 << 0)
#define BG2_ENABLE (1 << 1)
#define BG3_ENABLE (1 << 2)
#define BG4_ENABLE (1 << 3)
#define OBJ_ENABLE (1 << 4)
 
#define BG_4COLORS0 32
#define BG_4COLORS 4
#define BG_16COLORS 16
#define BG_256COLORS 256
#define BG3_MODE1_PRIORITY_HIGH (1 << 3)
 
#define REG_BGMODE (*(vuint8 *)0x2105)
 
#define REG_MOSAIC (*(vuint8 *)0x2106)
 
#define BG1SC_ADDR 0x2107
#define REG_BG1SC (*(vuint8 *)0x2107)
#define REG_BG2SC (*(vuint8 *)0x2108)
#define REG_BG3SC (*(vuint8 *)0x2109)
#define REG_BG4SC (*(vuint8 *)0x210A)
 
#define REG_BG12NBA (*(vuint8 *)0x210B)
#define REG_BG34NBA (*(vuint8 *)0x210C)
 
#define REG_BGxHOFS 0x210D
#define REG_BGxVOFS 0x210E
 
#define REG_BG1HOFS (*(vuint8 *)0x210D)
#define REG_BG1VOFS (*(vuint8 *)0x210E)
#define REG_BG2HOFS (*(vuint8 *)0x210F)
#define REG_BG2VOFS (*(vuint8 *)0x2110)
#define REG_BG3HOFS (*(vuint8 *)0x2111)
#define REG_BG3VOFS (*(vuint8 *)0x2112)
#define REG_BG4HOFS (*(vuint8 *)0x2113)
#define REG_BG4VOFS (*(vuint8 *)0x2114)
 
#define COLWIN_OB13W1ENABLEIN (1 << 0)  
#define COLWIN_OB13W1ENABLEOUT (2 << 0) 
#define COLWIN_OB13W2ENABLEIN (1 << 2)  
#define COLWIN_OB13W2ENABLEOUT (2 << 2) 
#define COLWIN_MB24W1ENABLEIN (1 << 4)  
#define COLWIN_MB24W1ENABLEOUT (2 << 4) 
#define COLWIN_MB24W2ENABLEIN (1 << 6)  
#define COLWIN_MB24W2ENABLEOUT (2 << 6) 
#define REG_W12SEL (*(vuint8 *)0x2123)
#define REG_W34SEL (*(vuint8 *)0x2124)
#define REG_WOBJSEL (*(vuint8 *)0x2125)
 
#define REG_WH0 (*(vuint8 *)0x2126)
#define REG_WH1 (*(vuint8 *)0x2127)
#define REG_WH2 (*(vuint8 *)0x2128)
#define REG_WH3 (*(vuint8 *)0x2129)
 
#define REG_WBGLOG (*(vuint8 *)0x212A)
#define REG_WOBJLOG (*(vuint8 *)0x212B)
 
#define REG_TM (*(vuint8 *)0x212C)
#define REG_TS (*(vuint8 *)0x212D)
 
#define REG_TMW (*(vuint8 *)0x212E)
#define REG_TSW (*(vuint8 *)0x212F)
 
// background address
extern u16 bg0gfxaddr; 
extern u16 bg1gfxaddr; 
extern u16 bg2gfxaddr; 
extern u16 bg3gfxaddr; 
void bgSetGfxPtr(u8 bgNumber, u16 address);
 
void bgSetMapPtr(u8 bgNumber, u16 address, u8 mapSize);
 
void bgInitTileSet(u8 bgNumber, u8 *tileSource, u8 *tilePalette, u8 paletteEntry, u16 tileSize, u16 paletteSize, u16 colorMode, u16 address);
 
void bgInitTileSetLz(u8 bgNumber, u8 *tileSource, u8 *tilePalette, u8 paletteEntry, u16 paletteSize, u16 colorMode, u16 address);
 
void bgInitTileSetData(u8 bgNumber, u8 *tileSource, u16 tileSize, u16 address);
 
void bgInitMapTileSet7(u8 *tileSource, u8 *mapSource, u8 *tilePalette, u16 tileSize, u16 address);
 
void bgInitMapSet(u8 bgNumber, u8 *mapSource, u16 mapSize, u8 sizeMode, u16 address);
 
void bgSetScroll(u8 bgNumber, u16 x, u16 y);
 
void bgSetEnable(u8 bgNumber);
 
void bgSetDisable(u8 bgNumber);
 
void bgSetEnableSub(u8 bgNumber);
 
void bgSetDisableSub(u8 bgNumber);
 
void bgSetWindowsRegions(u8 bgNumber, u8 winNumber, u8 xLeft, u8 xRight);
 
#endif // SNES_BACKGROUND_INCLUDE