C and C++ integration with the XDG Basedir specification is provided, when compiling on Unix platforms, by the UntitledXDGBasedir library.
Enabling
To enable it, update your uvproj.yaml
so that the
xdg
key under enabled-modules
is set to
true
like this:
name: "MyProject"
version: "1.0.0.0"
engine-version: "1.0.0.0"
enabled-modules:
os: true
xdg: true
Then, regenerate the modules cache by running the following command:
user $ https://madladsquad.com/UVKBuildTool --generate <project directory>
After that, refresh your CMake project with
cmake ..
!
Event safety
The entire module is flagged as event safe at
Any time
Using the library
Check out the UntitledXDGBasedir wiki. Initial installation instructions can be skipped, as they are not relevant. All compile options are turned on
Checking for the module
To check for the module at compile time, use the
UIMGUI_XDG_BASEDIR_SUBMODULE_ENABLED
macro.
Runtime checking can be done using the xdg
member of the
ModuleSettings
struct. More info can be found here.
C API
You can find out more about the UntitledXDGBasedir library's C API here.
- Home
- Beginner content
- Install guide
- Creating and using the UI components
- The Instance
- The Init Info struct
- Textures
- Logging
- Unicode support
- Additional features
- Client-side bar
- Custom type definitions
- Memory management
- C API development
- Config files and Folders
- Interfaces
- Internal Event safety
- Customising the build system
- Modules system
- Collaborating with others
- Advanced content
- Developer and contributor resources
- Misc