diff --git a/include/libpdraw/gui/gui.hpp b/include/libpdraw/gui/gui.hpp index 30ba5b1..458d225 100644 --- a/include/libpdraw/gui/gui.hpp +++ b/include/libpdraw/gui/gui.hpp @@ -14,13 +14,19 @@ class IWidget; #include "canvas.hpp" #include "input.hpp" +/// Main root object of libpdraw +/** + * The main required global of the library. + * You MUST set g_pGUI to a valid pointer and run Setup() afterwards for anything to function. + */ class CatGUI { public: CatGUI(); ~CatGUI(); void Setup(); - Canvas* GetRootWindow(); + Canvas* GetRootWindow(); /**< Use to get a container you can add widgets to. */ Canvas* m_pRootWindow; }; +/** Must be a valid pointer for library to function. */ extern CatGUI* g_pGUI;