window.h

Go to the documentation of this file.

 
#ifndef OPENSNES_WINDOW_H
#define OPENSNES_WINDOW_H
 
#include <snes/types.h>
 
/*============================================================================
 * Window Identifiers
 *============================================================================*/
 
#define WINDOW_1    0
 
#define WINDOW_2    1
 
/*============================================================================
 * Layer Masks (for windowEnable/windowDisable)
 *============================================================================*/
 
#define WINDOW_BG1      BIT(0)
 
#define WINDOW_BG2      BIT(1)
 
#define WINDOW_BG3      BIT(2)
 
#define WINDOW_BG4      BIT(3)
 
#define WINDOW_OBJ      BIT(4)
 
#define WINDOW_MATH     BIT(5)
 
#define WINDOW_ALL_BG   (WINDOW_BG1 | WINDOW_BG2 | WINDOW_BG3 | WINDOW_BG4)
 
#define WINDOW_ALL      (WINDOW_ALL_BG | WINDOW_OBJ)
 
/*============================================================================
 * Window Logic Operations
 *============================================================================*/
 
#define WINDOW_LOGIC_OR     0
 
#define WINDOW_LOGIC_AND    1
 
#define WINDOW_LOGIC_XOR    2
 
#define WINDOW_LOGIC_XNOR   3
 
/*============================================================================
 * Window Masking Modes
 *============================================================================*/
 
#define WINDOW_MASK_INSIDE  0
 
#define WINDOW_MASK_OUTSIDE 1
 
/*============================================================================
 * Main Screen / Sub Screen Window Selection
 *============================================================================*/
 
#define WINDOW_MAIN_SCREEN  0
 
#define WINDOW_SUB_SCREEN   1
 
/*============================================================================
 * Core Window Functions
 *============================================================================*/
 
void windowInit(void);
 
void windowSetPos(u8 window, u8 left, u8 right);
 
void windowEnable(u8 window, u8 layers);
 
void windowDisable(u8 window, u8 layers);
 
void windowDisableAll(void);
 
void windowSetInvert(u8 window, u8 layers, u8 invert);
 
void windowSetLogic(u8 layer, u8 logic);
 
void windowSetMainMask(u8 layers);
 
void windowSetSubMask(u8 layers);
 
/*============================================================================
 * Window Effect Helpers
 *============================================================================*/
 
void windowCentered(u8 window, u8 width);
 
void windowSplit(u8 splitX);
 
#endif /* OPENSNES_WINDOW_H */