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)
 *============================================================================*/
 
/* The layers are named by LAYER_BG1..LAYER_BG4 and LAYER_OBJ (video.h), the
 * same bits everywhere a call takes a set of layers. WINDOW_MATH is the one
 * bit only the window has. */

#define WINDOW_MATH     BIT(5)

#define WINDOW_ALL_BG   0x0F

#define WINDOW_ALL      0x1F
 
/* WINDOW_BG1..WINDOW_BG4 and WINDOW_OBJ were removed on 2026-10-05: the layer
 * bits are LAYER_BG1..LAYER_OBJ (video.h), the same values (docs/UPGRADING.md). */
 
/*============================================================================
 * 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
 *============================================================================*/
 
/* These two are used by nothing in the library — the polarity is set with
 * windowSetInvert(). Their comments had it backwards (fullsnes, "2123h
 * W12SEL": an enabled, non-inverted window masks the area INSIDE it), so the
 * values are kept and the meaning is now stated as the hardware has it. */

#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 */