Introduction

Welcome to the FifeGUI API documentation. FifeGUI is a flexible, backend-agnostic GUI library designed to be easily integrated into games and applications. It provides a rich set of widgets, event handling, and theming capabilities while remaining decoupled from specific rendering or input libraries.

Architecture & Backends

FifeGUI operates on an abstraction layer that allows it to work with various underlying technologies. The core logic is separated from the implementation details via abstract interfaces:

Graphics: Supports multiple backends (e.g., OpenGL, SDL2).
Input: Abstracts keyboard and mouse input (Input interface).
Fonts & Images: Pluggable loaders and renderers for assets.

This design allows you to swap rendering engines without changing your GUI logic.

Navigating this Documentation

This documentation is primarily structured as an API reference. To navigate effectively:

Modules: Use the Modules tab to browse classes by logical category (e.g., Widgets, Events, Graphics & Rendering).
Class List: Use the Class List for a complete alphabetical index.
Hierarchy: Use the Class Hierarchy to understand inheritance relationships.

Getting Started

While this reference details every class and method, the best way to learn FifeGUI is by examining practical implementations:

Check the examples/ directory for minimal, standalone demonstrations.
Explore tests/integration/ for comprehensive usage scenarios and edge cases.

Contributing & Feedback

This documentation is a living project. If you encounter:

Errors, typos, or broken links
Inconsistent descriptions or missing parameters
Features that require more detailed explanation

Please do not hesitate to contribute! Submit issues or pull requests to our repository to help improve the quality of this documentation for everyone.