window.h File Reference

Definitions for sprite and background windows. More...

#include <nds/arm9/background.h>
#include <nds/arm9/sassert.h>
#include <nds/arm9/sprite.h>
#include <nds/arm9/video.h>
#include <nds/dma.h>
#include <nds/memory.h>
#include <nds/ndstypes.h>

Enumerations
enum	WINDOW {   WINDOW_0 = DISPLAY_WIN0_ON ,   WINDOW_1 = DISPLAY_WIN1_ON ,   WINDOW_OBJ = DISPLAY_SPR_WIN_ON ,   WINDOW_OUT = BIT(16) }
	The supported windows. More...

Functions
void	bgWindowDisable (int id, WINDOW window)
	Disables the window on the supplied background. More...
void	bgWindowEnable (int id, WINDOW window)
	Enables the window on the supplied background. More...
void	oamWindowDisable (OamState *oam, WINDOW w)
	Disables the specified OAM window. More...
void	oamWindowEnable (OamState *oam, WINDOW w)
	Enables the specified OAM window. More...
static void	windowDisable (WINDOW w)
	Disable the specified window(s) (main engine). More...
static void	windowDisableSub (WINDOW w)
	Disable the specified window(s) (sub engine). More...
static void	windowEnable (WINDOW w)
	Enable the specified window(s) (main engine). More...
static void	windowEnableSub (WINDOW w)
	Enable the specified window(s) (sub engine). More...
void	windowSetBounds (WINDOW window, u8 left, u8 top, u8 right, u8 bottom)
	Set the windows bounds (main engine). More...
void	windowSetBoundsSub (WINDOW window, u8 left, u8 top, u8 right, u8 bottom)
	Set the windows bounds (sub engine). More...

Detailed Description

Definitions for sprite and background windows.

Enumeration Type Documentation

WINDOW

enum WINDOW

The supported windows.

Enumerator
WINDOW_0	Window 0.
WINDOW_1	Window 1.
WINDOW_OBJ	Object window.
WINDOW_OUT	Area outside all windows.

Function Documentation

bgWindowDisable()

void bgWindowDisable	(	int	id,
		WINDOW	window
	)

Disables the window on the supplied background.

Parameters

id	Background ID returned from bgInit or bgInitSub.
window	The window to disable.

bgWindowEnable()

void bgWindowEnable	(	int	id,
		WINDOW	window
	)

Enables the window on the supplied background.

Parameters

id	Background ID returned from bgInit or bgInitSub.
window	The window to enable.

oamWindowDisable()

void oamWindowDisable	(	OamState *	oam,
		WINDOW	w
	)

Disables the specified OAM window.

Parameters

oam	Must be &oamMain or &oamSub.
w	The window to disable.

oamWindowEnable()

void oamWindowEnable	(	OamState *	oam,
		WINDOW	w
	)

Enables the specified OAM window.

Parameters

oam	Must be &oamMain or &oamSub.
w	The window to enable.

windowDisable()

static void windowDisable ( WINDOW  w )

inlinestatic

Disable the specified window(s) (main engine).

Parameters

w	The window to set bounds on (may be ORed together).

windowDisableSub()

static void windowDisableSub ( WINDOW  w )

inlinestatic

Disable the specified window(s) (sub engine).

Parameters

w	The window to set bounds on (may be ORed together).

windowEnable()

static void windowEnable ( WINDOW  w )

inlinestatic

Enable the specified window(s) (main engine).

Parameters

w	The window to set bounds on (may be ORed together).

windowEnableSub()

static void windowEnableSub ( WINDOW  w )

inlinestatic

Enable the specified window(s) (sub engine).

Parameters

w	The window to set bounds on (may be ORed together).

windowSetBounds()

void windowSetBounds	(	WINDOW	window,
		u8	left,
		u8	top,
		u8	right,
		u8	bottom
	)

Set the windows bounds (main engine).

Parameters

window	The window to set bounds on.
left	The X coordinate of the left hand side of the rectangle.
top	The Y coordinate of the top of the rectangle.
right	The X coordinate of the right hand side of the rectangle.
bottom	The Y coordinate of the bottom of the rectangle.

windowSetBoundsSub()

void windowSetBoundsSub	(	WINDOW	window,
		u8	left,
		u8	top,
		u8	right,
		u8	bottom
	)

Set the windows bounds (sub engine).

Parameters

window	The window to set bounds on.
left	The X coordinate of the left hand side of the rectangle.
top	The Y coordinate of the top of the rectangle.
right	The X coordinate of the right hand side of the rectangle.
bottom	The Y coordinate of the bottom of the rectangle.