Unilayer Graphical User Interface

In-engine interface for windows. More...

Collaboration diagram for Unilayer Graphical User Interface:

Modules
	GUI Window Flags
	Options specifying how a WINDOW behaves.
	GUI Window Placement
	Options for specifying WINDOW placement in a WINDOW.
	GUI Window Types
	Window interaction modes.

Files
file	window.h
	Tools for drawing and interacting with graphical windows on-screen.

Data Structures
union	CONTROL_DATA
	A piece of data attached to CONTROL::data. More...
struct	WINDOW_FRAME
	Defines a graphical window frame/background with a set of image assets. More...
struct	WINDOW
	Struct representing an on-screen graphical window. More...

Macros
#define	GUI_X   0
	Specifies X coordinate in WINDOW::coords.
#define	GUI_Y   1
	Specifies X coordinate in WINDOW::coords.
#define	GUI_W   2
	Specifies width coordinate in WINDOW::coords.
#define	GUI_H   3
	Specifies height in WINDOW::coords.
#define	WINDOW_NUM_BUFFER_SZ   10
	Size of internal text buffer used to represent WINDOW_FLAG_TEXT_NUM.
#define	WINDOW_STRING_SZ_MAX   100
#define	window_trace_printf(...)
	Alias for debug_printf() enabled when WINDOW_TRACE is defined.
#define	window_modal()   (g_window_modals)
#define	WINDOW_CB_TABLE_CONSTS(idx, name)   extern RES_CONST uint16_t WINDOW_TYPE_ ## name;
	Define extern constants that can be used e.g. in spawners.

Typedefs
typedef int16_t(*	WINDOW_CB_DRAW) (uint16_t w_id, struct WINDOW *windows)
typedef uint8_t(*	WINDOW_CB_SZ) (uint16_t w_id, struct WINDOW *windows, uint8_t w_h, uint16_t *out)

Functions
int16_t	window_init (uint16_t auto_x, uint16_t auto_y, uint16_t auto_w, uint16_t auto_h) SECTION_WINDOW
	Global initialization for the window subsystem. Runs at startup.
int16_t	window_reload_frames () SECTION_WINDOW
void	window_shutdown () SECTION_WINDOW
	Global shutdown for the window subsystem. Runs at shutdown.
int16_t	window_draw_all ()
int16_t	window_push (uint16_t id, uint16_t parent_id, uint8_t type, uint8_t flags, uint16_t x, uint16_t y, uint16_t w, uint16_t h, GRAPHICS_COLOR fg, GRAPHICS_COLOR bg, uint8_t render_flags, int32_t data_scalar, const char *data_string) SECTION_WINDOW
	Push a new window onto the global window stack.
void	window_pop (uint16_t id) SECTION_WINDOW
	Destroy the top-most onscreen WINDOW with the given WINDOW::id.
void	window_refresh (uint16_t w_id) SECTION_WINDOW

Variables
uint8_t	g_window_modals

Detailed Description

In-engine interface for windows.

Windows are nested graphical controls that can be used to create an interactive interface. There are various GUI Window Types which can be used together to construct dialog boxes and menus.

Warning

This API is still heavily in development and is subject to change without notice!

Macro Definition Documentation

window_trace_printf

#define window_trace_printf

(

...

)

Alias for debug_printf() enabled when WINDOW_TRACE is defined.

This was made its own alias since the GUI can get rather chatty when it's enabled!

Typedef Documentation

WINDOW_CB_SZ

typedef uint8_t(* WINDOW_CB_SZ) (uint16_t w_id, struct WINDOW *windows, uint8_t w_h, uint16_t *out)

Returns

1 if successful and 0 otherwise.

Function Documentation

window_init()

int16_t window_init	(	uint16_t	auto_x,
		uint16_t	auto_y,
		uint16_t	auto_w,
		uint16_t	auto_h
	)

Global initialization for the window subsystem. Runs at startup.

Parameters

auto_w	Limit width of screen area for auto-centering.
auto_h	Limit height of screen area for auto-centering.

Returns

1 if successful, or 0 otherwise.

window_pop()

void window_pop

(

uint16_t

id

)

Destroy the top-most onscreen WINDOW with the given WINDOW::id.

Parameters

id	WINDOW::id to search for and eliminate.
windows	Locked MEMORY_PTR to the global window list.

window_push()

int16_t window_push	(	uint16_t	id,
		uint16_t	parent_id,
		uint8_t	type,
		uint8_t	flags,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h,
		GRAPHICS_COLOR	fg,
		GRAPHICS_COLOR	bg,
		uint8_t	render_flags,
		int32_t	data_scalar,
		const char *	data_string
	)

Push a new window onto the global window stack.

Parameters

id	WINDOW::id for the window being pushed.
status	Initial WINDOW::status for the window being pushed.
x	The left horizontal offset of the window in pixels.
y	The top vertical offset of the window in pixels.
w	The width of the window in pixels.
h	The height of the window in pixels.
frame_idx	The index of the window frame to use.
windows	Locked MEMORY_PTR to the global window list.