66 lines (52 loc) · 5.17 KB

API Reference

TODO - proper page generation.

In the meantime, check out the libraries headers directly. COBJ and CCFG functions and type are fully described. CGUI is a WIP.

CGUI

Top level headers

file	description
cgui.h	GUI session management and umbrella header
cgui-clipboard.h	copy & paste actions
cgui-grid.h	WGC grid
cgui-screen.h	monitor and pointer information
cgui-window.h	WGC window

Top level headers - cells

file	description
cgui-beacon.h	warning label that can light up and blink
cgui-button.h	basic button with callback on click
cgui-filler.h	just a box, to fill empty space in layouts
cgui-label.h	basic static label
cgui-gauge.h	progress bar
cgui-placeholder.h	static box with a cross
cgui-stripes.h	static box with diagonal hazard stripes

Low level headers

file	description
cgui-attributes.h	GCC function attributes
cgui-box.h	drawing primitive
cgui-cell.h	WGC cell, api to create custom cells
cgui-config.h	access to configuration and theme data
cgui-event.h	access to window and session events
cgui-swap.h	input swap map values definition
cgui-text.h	drawing primitive
cgui-types.h	misc structs and enums

CCFG

file	description
ccfg.h	main and only header, CCFG parser instantiation and manipulation

COBJ

file	description
cbook.h	dynamic C-strings stack with grouping features
ccolor.h	RGBA color representation, manipulation and conversion
cdict.h	hashmap with string + group keys, FNV-1A hashing and linear probing
cerr.h	error codes used by every Cassette component
cinputs.h	2D input (screen touches, key / button presses) tracker array
cobj.h	umbrella header
crand.h	re-implementation of POSIX's rand48 functions with a slightly more convenient API
cref.h	reference counter used to keep track of instanced components
csafe.h	set of arithmetics operations on size_t with overflow and underflow protection
cseg.h	1D segment represenation and manipulation with bound checks and UB prevention
cstr.h	UTF-8 strings with 2D (rows, columns, tabsize, wrapping) features