window.h File Reference

windowing support functions for objects and backgrounds More...

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

Enumerations

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 window. More...
void	oamWindowEnable (OamState *oam, WINDOW w)
	Enables the specified window. More...
static void	windowDisable (WINDOW w)
	Enable the specified window(s) More...
static void	windowDisableSub (WINDOW w)
	Enable the specified window(s) More...
static void	windowEnable (WINDOW w)
	Enable the specified window(s) More...
static void	windowEnableSub (WINDOW w)
	Enable the specified window(s) More...
void	windowSetBounds (WINDOW window, u8 left, u8 top, u8 right, u8 bottom)
	Set the windows bounds. More...
void	windowSetBoundsSub (WINDOW window, u8 left, u8 top, u8 right, u8 bottom)
	Set the windows bounds (Sub engine) More...

Detailed Description

windowing support functions for objects and backgrounds

Enumeration Type Documentation

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

void bgWindowDisable	(	int	id,
		WINDOW	window
	)

Disables the window on the supplied background.

Parameters

id	background id returned from bgInit or bgInitSub
window	the the window to disable

void bgWindowEnable	(	int	id,
		WINDOW	window
	)

Enables the window on the supplied background.

Parameters

id	background id returned from bgInit or bgInitSub
window	the the window to enable

void oamWindowDisable	(	OamState *	oam,
		WINDOW	w
	)

Disables the specified window.

Parameters

oam	must be: &oamMain or &oamSub
the	window to disable

void oamWindowEnable	(	OamState *	oam,
		WINDOW	w
	)

Enables the specified window.

Parameters

oam	must be: &oamMain or &oamSub
the	window to enable

static void windowDisable ( WINDOW  w )

inlinestatic

Enable the specified window(s)

Parameters

window

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

static void windowDisableSub ( WINDOW  w )

inlinestatic

Enable the specified window(s)

Parameters

window

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

static void windowEnable ( WINDOW  w )

inlinestatic

Enable the specified window(s)

Parameters

window

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

static void windowEnableSub ( WINDOW  w )

inlinestatic

Enable the specified window(s)

Parameters

window

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

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

Set the windows bounds.

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

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