---

msh_disp.h File Reference

Display control functions. More...

Defines
#define	set_disp_mode(mode)   SET_DISP_MODE(mode)
#define	set_disp_frmbuf(frmbuf)   SET_DISP_FRMBUF(frmbuf)
#define	set_disp_hblproc(hblproc)   SET_DISP_HBLPROC(hblproc)
#define	set_disp_objmap(objmap)   SET_DISP_OBJMAP(objmap)
#define	set_disp_frcblk(frcblk)   SET_DISP_FRCBLK(frcblk)
#define	set_disp_bg0(bg0)   SET_DISP_BG0(bg0)
#define	set_disp_bg1(bg1)   SET_DISP_BG1(bg1)
#define	set_disp_bg2(bg2)   SET_DISP_BG2(bg2)
#define	set_disp_bg3(bg3)   SET_DISP_BG3(bg3)
#define	set_disp_obj(obj)   SET_DISP_OBJ(obj)
#define	set_disp_win0(win0)   SET_DISP_WIN0(win0)
#define	set_disp_win1(win1)   SET_DISP_WIN1(win1)
#define	set_disp_objwin(objwin)   SET_DISP_OBJWIN(objwin)
#define	get_disp_mode()   GET_DISP_MODE()
#define	get_disp_gbcmode()   GET_DISP_GBCMODE()
#define	get_disp_frmbuf()   GET_DISP_FRMBUF()
#define	get_disp_hblproc()   GET_DISP_HBLPROC()
#define	get_disp_objmap()   GET_DISP_OBJMAP()
#define	get_disp_frcblk()   GET_DISP_FRCBLK()
#define	get_disp_bg0()   GET_DISP_BG0()
#define	get_disp_bg1()   GET_DISP_BG1()
#define	get_disp_bg2()   GET_DISP_BG2()
#define	get_disp_bg3()   GET_DISP_BG3()
#define	get_disp_obj()   GET_DISP_OBJ()
#define	get_disp_win0()   GET_DISP_WIN0()
#define	get_disp_win1()   GET_DISP_WIN1()
#define	get_disp_objwin()   GET_DISP_OBJWIN()
#define	get_disp_vstat()   GET_DISP_VSTAT()
#define	get_disp_hstat()   GET_DISP_HSTAT()
#define	get_disp_vcountstat()   GET_DISP_VCOUNTSTAT()
#define	set_disp_vblirq(vblirq)   SET_DISP_VBLIRQ(vblirq)
#define	set_disp_hblirq(hblirq)   SET_DISP_HBLIRQ(hblirq)
#define	set_disp_vcountirq(vcountirq)   SET_DISP_VCOUNTIRQ(vcountirq)
#define	set_disp_vcounttrig(vcounttrig)   SET_DISP_VCOUNTTRIG(vcounttrig)
#define	get_disp_vblirq()   GET_DISP_VBLIRQ()
#define	get_disp_hblirq()   GET_DISP_HBLIRQ()
#define	get_disp_vcountirq()   GET_DISP_VCOUNTIRQ()
#define	get_disp_vcounttrig()   GET_DISP_VCOUNTTRIG()
#define	wait_vbl()   WAIT_VBL()
#define	set_disp_bg(bg, show)   SET_DISP_BG(bg, show)
#define	get_disp_bg(bg)   GET_DISP_BG(bg)
#define	set_disp_win(win, show)   SET_DISP_WIN(win, show)
#define	get_disp_win(win)   GET_DISP_WIN(win)

---

Detailed Description

---

Define Documentation

#define SET_DISP_MODE (  mode    )

Value: {REG_DISPCNT &= _DISP_MODE_MASK; \ REG_DISPCNT |= (mode);}

#define SET_DISP_FRMBUF (  frmbuf    )

Value: {REG_DISPCNT &= _DISP_FRMBUF_MASK; \ REG_DISPCNT |= (frmbuf) << _DISP_FRMBUF_POS;}

#define SET_DISP_HBLPROC (  hblproc    )

Value: {REG_DISPCNT &= _DISP_HBLPROC_MASK; \ REG_DISPCNT |= (hblproc) << _DISP_HBLPROC_POS;}

#define SET_DISP_OBJMAP (  objmap    )

Value: {REG_DISPCNT &= _DISP_OBJMAP_MASK; \ REG_DISPCNT |= (objmap) << _DISP_OBJMAP_POS;}

#define SET_DISP_FRCBLK (  frcblk    )

Value: {REG_DISPCNT &= _DISP_FRCBLK_MASK; \ REG_DISPCNT |= (frcblk) << _DISP_FRCBLK_POS;}

#define SET_DISP_BG0 (  bg0    )

Value: {REG_DISPCNT &= _DISP_BG0_MASK; \ REG_DISPCNT |= (bg0) << _DISP_BG0_POS;}

#define SET_DISP_BG1 (  bg1    )

Value: {REG_DISPCNT &= _DISP_BG1_MASK; \ REG_DISPCNT |= (bg1) << _DISP_BG1_POS;}

#define SET_DISP_BG2 (  bg2    )

Value: {REG_DISPCNT &= _DISP_BG2_MASK; \ REG_DISPCNT |= (bg2) << _DISP_BG2_POS;}

#define SET_DISP_BG3 (  bg3    )

Value: {REG_DISPCNT &= _DISP_BG3_MASK; \ REG_DISPCNT |= (bg3) << _DISP_BG3_POS;}

#define SET_DISP_OBJ (  obj    )

Value: {REG_DISPCNT &= _DISP_OBJ_MASK; \ REG_DISPCNT |= (obj) << _DISP_OBJ_POS;}

#define SET_DISP_WIN0 (  win0    )

Value: {REG_DISPCNT &= _DISP_WIN0_MASK; \ REG_DISPCNT |= (win0) << _DISP_WIN0_POS;}

#define SET_DISP_WIN1 (  win1    )

Value: {REG_DISPCNT &= _DISP_WIN1_MASK; \ REG_DISPCNT |= (win1) << _DISP_WIN1_POS;}

#define SET_DISP_OBJWIN (  objwin    )

Value: {REG_DISPCNT &= _DISP_OBJWIN_MASK; \ REG_DISPCNT |= (objwin) << _DISP_OBJWIN_POS;}

#define SET_DISP_VBLIRQ (  vblirq    )

Value: {REG_DISPSTAT &= _DISP_VBLIRQ_MASK; \ REG_DISPSTAT |= (vblirq) << _DISP_VBLIRQ_POS;}

#define SET_DISP_HBLIRQ (  hblirq    )

Value: {REG_DISPSTAT &= _DISP_HBLIRQ_MASK; \ REG_DISPSTAT |= (hblirq) << _DISP_HBLIRQ_POS;}

#define SET_DISP_VCOUNTIRQ (  vcountirq    )

Value: {REG_DISPSTAT &= _DISP_VCOUNTIRQ_MASK; \ REG_DISPSTAT |= (vcountirq) << _DISP_VCOUNTIRQ_POS;}

#define SET_DISP_VCOUNTTRIG (  vcounttrig    )

Value: {REG_DISPSTAT &= _DISP_VCOUNTTRIG_MASK; \ REG_DISPSTAT |= (vcounttrig) << _DISP_VCOUNTTRIG_POS;}

#define WAIT_VBL (    )

Value: {while (REG_VCOUNT != 159); \ while (REG_VCOUNT == 159);}

#define SET_DISP_BG (  bg, show    )

Value: {REG_DISPCNT &= ~(1 << (_DISP_BG0_POS + (bg))); \ REG_DISPCNT |= (show) << (_DISP_BG0_POS + (bg));}

#define SET_DISP_WIN (  win, show    )

Value: {REG_DISPCNT &= ~(1 << (_DISP_WIN0_POS + (win))); \ REG_DISPCNT |= (show) << (_DISP_WIN0_POS + (win));}

#define set_disp_mode (  mode    )     SET_DISP_MODE(mode)

Parameters: mode  u8 [0..5] Display Mode

#define set_disp_frmbuf (  frmbuf    )     SET_DISP_FRMBUF(frmbuf)

Parameters: frmbuf  bool [0..1] BG Frame Buffer Only available in modes 4 and 5.

#define set_disp_hblproc (  hblproc    )     SET_DISP_HBLPROC(hblproc)

Parameters: hblproc  bool [TRUE or FALSE] Enable/Disable HBL Processing

#define set_disp_objmap (  objmap    )     SET_DISP_OBJMAP(objmap)

Parameters: objmap  bool [DISP_OBJMAP] Object Map Format Object Map Type defines: */ #define DISP_OBJMAP_2D #define DISP_OBJMAP_1D

#define set_disp_frcblk (  frcblk    )     SET_DISP_FRCBLK(frcblk)

Parameters: frcblk  bool [TRUE or FALSE] Enable/Disable Force Blank

#define set_disp_bg0 (  bg0    )     SET_DISP_BG0(bg0)

Parameters: bg0  bool [TRUE or FALSE] Show/Hide BG0

#define set_disp_bg1 (  bg1    )     SET_DISP_BG1(bg1)

Parameters: bg1  bool [TRUE or FALSE] Show/Hide BG1

#define set_disp_bg2 (  bg2    )     SET_DISP_BG2(bg2)

Parameters: bg2  bool [TRUE or FALSE] Show/Hide BG2

#define set_disp_bg3 (  bg3    )     SET_DISP_BG3(bg3)

Parameters: bg3  bool [TRUE or FALSE] Show/Hide BG3

#define set_disp_obj (  obj    )     SET_DISP_OBJ(obj)

Parameters: obj  bool [TRUE or FALSE] Show/Hide Objects

#define set_disp_win0 (  win0    )     SET_DISP_WIN0(win0)

Parameters: win0  bool [TRUE or FALSE] Enable/Disable WIN0

#define set_disp_win1 (  win1    )     SET_DISP_WIN1(win1)

Parameters: win1  bool [TRUE or FALSE] Enable/Disable WIN1

#define set_disp_objwin (  objwin    )     SET_DISP_OBJWIN(objwin)

Parameters: objwin  bool [TRUE or FALSE] Enable/Disable Object Windows

#define get_disp_mode (    )     GET_DISP_MODE()

Returns: u8 [0..5] Display Mode

#define get_disp_gbcmode (    )     GET_DISP_GBCMODE()

Returns: bool [TRUE or FALSE] Game Boy Color Mode

#define get_disp_frmbuf (    )     GET_DISP_FRMBUF()

Returns: bool [0..1] BG Frame Buffer

#define get_disp_hblproc (    )     GET_DISP_HBLPROC()

Returns: bool [TRUE or FALSE] Enable/Disable HBL Processing

#define get_disp_objmap (    )     GET_DISP_OBJMAP()

Returns: bool [DISP_OBJMAP] Object Map Format Object Map Type defines: */ #define DISP_OBJMAP_2D #define DISP_OBJMAP_1D

#define get_disp_frcblk (    )     GET_DISP_FRCBLK()

Returns: bool [TRUE or FALSE] Enable/Disable Force Blank

#define get_disp_bg0 (    )     GET_DISP_BG0()

Returns: bool [TRUE or FALSE] Show/Hide BG0

#define get_disp_bg1 (    )     GET_DISP_BG1()

Returns: bool [TRUE or FALSE] Show/Hide BG1

#define get_disp_bg2 (    )     GET_DISP_BG2()

Returns: bool [TRUE or FALSE] Show/Hide BG2

#define get_disp_bg3 (    )     GET_DISP_BG3()

Returns: bool [TRUE or FALSE] Show/Hide BG3

#define get_disp_obj (    )     GET_DISP_OBJ()

Returns: bool [TRUE or FALSE] Show/Hide Objects

#define get_disp_win0 (    )     GET_DISP_WIN0()

Returns: bool [TRUE or FALSE] Enable/Disable WIN0

#define get_disp_win1 (    )     GET_DISP_WIN1()

Returns: bool [TRUE or FALSE] Enable/Disable WIN1

#define get_disp_objwin (    )     GET_DISP_OBJWIN()

Returns: bool [TRUE or FALSE] Enable/Disable Object Windows

#define get_disp_vstat (    )     GET_DISP_VSTAT()

Returns: bool [0..1] V Refresh Status Returns 0 during VDraw and 1 during VBlank.

#define get_disp_hstat (    )     GET_DISP_HSTAT()

Returns: bool [0..1] H Refresh Status Returns 0 during HDraw and 1 during HBlank.

#define get_disp_vcountstat (    )     GET_DISP_VCOUNTSTAT()

Returns: bool [0..1] VCount Triggered Status Gets set to 1 when a VCount trigger interrupt occurs.

#define set_disp_vblirq (  vblirq    )     SET_DISP_VBLIRQ(vblirq)

Parameters: vblirq  bool [TRUE or FALSE] Enable/Disable VBL IRQ

#define set_disp_hblirq (  hblirq    )     SET_DISP_HBLIRQ(hblirq)

Parameters: hblirq  bool [TRUE or FALSE] Enable/Disable HBL IRQ

#define set_disp_vcountirq (  vcountirq    )     SET_DISP_VCOUNTIRQ(vcountirq)

Parameters: vcountirq  bool [TRUE or FALSE] Enable/Disable VCount IRQ

#define set_disp_vcounttrig (  vcounttrig    )     SET_DISP_VCOUNTTRIG(vcounttrig)

Parameters: vcounttrig  u8 [0..227] VCount Line Trigger

#define get_disp_vblirq (    )     GET_DISP_VBLIRQ()

Returns: bool [TRUE or FALSE] Enable/Disable VBL IRQ

#define get_disp_hblirq (    )     GET_DISP_HBLIRQ()

Returns: bool [TRUE or FALSE] Enable/Disable HBL IRQ

#define get_disp_vcountirq (    )     GET_DISP_VCOUNTIRQ()

Returns: bool [TRUE or FALSE] Enable/Disable VCount IRQ

#define get_disp_vcounttrig (    )     GET_DISP_VCOUNTTRIG()

Returns: u8 [0..227] VCount Line Trigger

#define wait_vbl (    )     WAIT_VBL()

Waits for the start of a new VBL. If already in a VBL then it will wait for the next new VBL.

#define set_disp_bg (  bg, show    )     SET_DISP_BG(bg, show)

Parameters: bg  [0..3] Background show  [TRUE or FALSE] Show background Shows or hides the specified background layer

#define get_disp_bg (  bg    )     GET_DISP_BG(bg)

Parameters: bg  [0..3] Background Returns: [TRUE or FALSE] Show background Returns TRUE if the specified background layer is displayed, or FALSE if it is hidden

#define set_disp_win (  win, show    )     SET_DISP_WIN(win, show)

Parameters: win  [0..1] Window show  [TRUE or FALSE] Show window Shows or hides the specified window

#define get_disp_win (  win    )     GET_DISP_WIN(win)

Parameters: win  [0..1] Window Returns: [TRUE or FALSE] Show window Returns TRUE if the specified window is displayed, or FALSE if it is hidden

---