In this page, we will list and explain what each of these core files does.
Core/Components
The Components
directory has the following files:
InlineComponent
- Defines the abstract class for inline components. DocumentationWindowComponent
- Defines the abstract class for window components. DocumentationTitlebarComponent
- Defines the abstract class for title bar components. DocumentationInstance
- Defines the baseInstance
class. Documentation
Core/Events
The Events
directory contains the following files:
Input
- Defines the Input interface. DocumentationKeys
- Defines key code constants for every key on a standard QWERTY keyboard.
Core/Interfaces
The Interfaces
directory contains the following files:
RendererInterface
- Defines theRenderer
interface. DocumentationWindowInterface
- Defines theWindow
. Documentation
Core/
The Core
directory contains the following files:
Core.hpp
- A bunch of header files that are widely used internallyDefines.hpp
- Defines and constants that are used internally. DocumentationGlobal
- Defines the global internal variable. DocumentationTypes.hpp
- Contains many type definitions and aliases. DocumentationUtilities
- The Utilities interface is defined here. DocumentationCDeallocation.hpp
- A header containing a struct that stores intermediate data for the C API. Documentation
Modules/
The Modules
folder contains the modules + Modules.hpp
which includes all modules. Documentation
Modules/Manager
The Manager
folder contains the Modules
interface and the ModulesManager
internal classes. Documentation, Internal Documentation
Renderer
The Renderer
folder contains the rendering code. The Renderer
files define the internal renderer and the RendererData
struct. Documentation
Renderer/ImGui/ImGui
This class defines internal code that sets up dear imgui. Documentation
Renderer/Utils
The Utils
folder contains the following files:
Texture
- The texture class used to load images. DocumentationWindow
- The internal Window class. Documentation
Framework.hpp
Includes header files that are going to be used by all files generated under the Source
directory.
C/UImGuiCAPI.h
Includes all header files part of the C API. Included by Framework.hpp
.
- Home
- Beginner content
- Install guide
- Creating and using the UI components
- The Instance
- The Init Info struct
- Additional features
- Custom type definitions
- C API development
- Config files and Folders
- Interfaces
- Internal Event safety
- Modules system
- I18N
- Plotting
- Knobs
- Spinners
- Toggles
- Text Utils
- Undo/Redo
- CLI Parser
- Theming
- OS
- Opening URLs and using file pickers
- Exec integration
- Fonts
- Unix
- DBus utilities
- XDG integration
- Collaborating with others
- Advanced content
- Loading dynamic libraries at runtime
- Understanding the library layout
- Compilation mode modifiers
- Adding plugin support to your application
- Production export and deployment
- Developer and contributor resources
- Misc