Aurore
Environment variables
Cette page n'est pas encore traduite : la voici en anglais.
Sur cette page
Every environment variable Aurore reads, in one place. None is needed: each one turns on a debugging aid, overrides what the system says, or steers the tests. They are read on the desktop (Windows, macOS, Linux) unless the table says otherwise; the consoles have no environment to set.
A flag is on when it is set to anything but 0 (Cadran's: 1, true or yes).
The library
| Variable | Read by | Effect |
|---|---|---|
AURORE_INSPECTOR |
Application::init() |
1 turns the inspector on (F12, or L3 + R3), 0 off, even in a build made with -DAURORE_INSPECTOR=ON |
AURORE_HOT_RELOAD |
Application::init() |
1 turns hot reload on; a folder ($PWD/resources) also reads the XML from there instead of the copy next to the program. Not on the consoles |
AURORE_PROFILE |
Profiler |
1 measures every frame and logs averages every 120 frames (testing.md). Not on the Switch nor in a browser |
AURORE_REDRAW_DEBUG |
Application::init() |
1 checks redraw on demand: each frame it skips is drawn anyway and compared, a difference logged as a warning (Application::setRedrawDebug, OpenGL only). Not on the Switch nor in a browser |
AURORE_RESOURCES_DIR |
libromfs | With the resources built in (-DAURORE_LIBROMFS=ON): a folder laid out like resources/ whose files are read before the built-in ones, so changed XML, pictures or translations need only a restart |
AURORE_THEME (older name AURORE_THEME) |
the desktop platform | DARK starts in the dark variant, anything else in the light one, instead of the system's mode. With Cadran on, the preferences' theme (ui::Prefs::theme, dark by default) is applied over it: the demo maps AURORE_THEME=LIGHT onto them. AURORE_THEME wins when both are set |
AURORE_LANG (older name AURORE_LANG) |
the desktop platform | The language, when the app did not set Platform::APP_LOCALE_DEFAULT: a name as Aurore spells it (fr, zh-Hant, es-419) or as a system does (fr_FR.UTF-8). It wins over the system's language under GLFW and SDL alike; AURORE_LANG wins when both are set |
LANGUAGE, LC_ALL, LC_MESSAGES, LANG |
the GLFW platform, on Linux | The system's language, the first one set (and not C or POSIX); in LANGUAGE, the first of a list (fr:en). Not read when AURORE_LANG is set. (Windows: the display language and its region; macOS: the first preferred language) |
SteamDeck |
the desktop platform, on Linux | Set by Steam on a Steam Deck: the screen's brightness through the Deck's backlight, links opened and the keyboard shown through Steam (GLFW) |
systemroot |
the desktop fonts, on Windows | Where Windows' fonts are (C:\Windows\Fonts), for Chinese, Japanese and Korean |
The debugging aids above (AURORE_INSPECTOR, AURORE_HOT_RELOAD, AURORE_PROFILE, AURORE_REDRAW_DEBUG) are read only in a build made with AURORE_DEV_TOOLS. It is AUTO by default: on, except in Release and MinSizeRel builds, where these variables do nothing. -DAURORE_DEV_TOOLS=ON reads them in a release build too (a simulator built in Release), OFF in none (hot reload). Their functions (Application::setInspectorEnabled, setHotReload, Profiler::setEnabled, setRedrawDebug) work in every build.
Cadran
Cadran's flags help tests and screenshots of an app. They are read through ui::env_flag("NAME"), which reads AURORE_NAME in a build with AURORE_DEV_TOOLS (above: not a Release one, by default); an app that sets ui::hooks::get().env_flag answers them itself in every build (its own variables, a test's settings). On the Switch they are all off.
| Variable | Effect |
|---|---|
AURORE_STILL_FOCUS |
The focus glow and every movement held still (Application::getReduceMotion() is then true) |
AURORE_CADRAN_NOGLOW |
No background glow on the screens |
AURORE_FOCUS_LOG |
Each focused line logged by its title |
AURORE_CUT_TEXT |
Every label cut short ("…") written to cut_text.txt |
AURORE_DOCKED |
The console on its dock: larger text when the text size is "auto" |
AURORE_BATTERY |
The console in hand, on battery: the lighter effects when they are "auto" |
The test harness
Read by the test harness (-DAURORE_BUILD_TESTS=ON) and the demo's tests.
| Variable | Effect |
|---|---|
AURORE_TEST_REFERENCES |
The folder of the reference screenshots, when the test's options name none (default references) |
AURORE_TEST_OUTPUT |
The folder the screenshots and their differences are written to (default test-output) |
AURORE_TEST_UPDATE |
1 writes every reference again from the screenshots taken, to commit after looking at them |
CI |
Set (as on GitHub Actions): a missing reference fails instead of being written |
AURORE_HEADLESS_GLFW |
1 draws in a hidden GLFW window instead of EGL's surfaceless context (needs a display) |
AURORE_DECOR_SHOTS |
tests/demo_tests.cpp only: a folder where the case of the theme decorations saves a picture of each kind of particles |
Names
Every variable starts with AURORE_. AURORE_RESOURCES_DIR belongs to the bundled libromfs; the CMake variable AURORE_RESOURCES_ROOT, the folder that holds resources/ on a desktop, is another thing. The build options are AURORE_ too, see platforms.md: those are set when building, not in the environment.
borealis' names are still read, deprecated, after the new one: BRLS_<name>, then BOREALIS_<name> (BRLS_LANG, BOREALIS_THEME, BRLS_INSPECTOR…); the log says once which one was used and its new name (migrating-from-borealis.md).