video.h

Go to the documentation of this file.

 
#ifndef OPENSNES_VIDEO_H
#define OPENSNES_VIDEO_H
 
#include <snes/types.h>
 
/*============================================================================
 * Screen dimensions (NTSC visible area)
 *============================================================================*/

#define SCREEN_WIDTH   256
#define SCREEN_HEIGHT  224
 
/*============================================================================
 * Background Modes
 *============================================================================*/

#define BG_MODE0    0   
#define BG_MODE1    1   
#define BG_MODE2    2   
#define BG_MODE3    3   
#define BG_MODE4    4   
#define BG_MODE5    5   
#define BG_MODE6    6   
#define BG_MODE7    7   

#define BG3_MODE1_PRIORITY_HIGH  0x08  

void setMode(u8 mode, u8 flags);
 
/*============================================================================
 * Palette
 *============================================================================*/

#define RGB(r, g, b) ((((b) & 31) << 10) | (((g) & 31) << 5) | ((r) & 31))

#define RGB24(r, g, b) RGB((r) >> 3, (g) >> 3, (b) >> 3)
 
/*============================================================================
 * Layer Enable Constants (for REG_TM / REG_TS / setMainScreen / setSubScreen)
 *============================================================================*/

#define LAYER_BG1   0x01  
#define LAYER_BG2   0x02  
#define LAYER_BG3   0x04  
#define LAYER_BG4   0x08  
#define LAYER_OBJ   0x10  
 
/*============================================================================
 * Screen Layer Control
 *============================================================================*/

#define setMainScreen(layers) (REG_TM = (u8)(layers))

#define setSubScreen(layers) (REG_TS = (u8)(layers))
 
/*============================================================================
 * Palette Helpers
 *============================================================================*/

#define setColor(index, color) do { \
    REG_CGADD = (u8)(index); \
    REG_CGDATA = (u8)((color) & 0xFF); \
    REG_CGDATA = (u8)(((color) >> 8) & 0xFF); \
} while(0)
 
/*============================================================================
 * Screen Mode Extras — SETINI ($2133)
 *============================================================================
 * SETINI is write-only; all four setters compose their bit through a
 * software shadow (same discipline as the NMITIMEN shadow), so they can
 * be combined freely and never clobber each other.
 *============================================================================*/

void videoSetInterlace(u8 on);

void videoSetObjInterlace(u8 on);

void videoSetOverscan(u8 on);
 
/* SETINI bit 6, Mode 7 EXTBG, has its setter in mode7.h (mode7SetExtBg),
 * composed through the same software copy. */

void videoSetPseudoHires(u8 on);
 
#endif /* OPENSNES_VIDEO_H */