regolith-ui/docs/design-doc.md

Regolith: A retained-mode GUI framework built with C on top of Clay

Status

Goals

Primary

• Retained mode
  • State management
  • Data binding
• Easy initalizaion
• Clean C API for creating bindings for other langs
• Renderer and backend agnostic
• Clay as the layout engine (Flexbox style with transitions support)
• Extensive Lua integration for both UI documents AND logic (totally optional, you can create the whole UI tree with the C API)
• Useful for both desktop applications and game UIs

Future

• IME support
• Accessibility support (Screen readers, etc)
• WASM support
• Official Odin bindings

Fever dream

• Android and iOS support
• Embedded devices support

Implementation details