Environment variables

OSU_TESTS_FORCED_GC

When running tests in a grouped fashion, unobserved exceptions will be thrown at the next garbage collection (as they are handled in the finalizer of related Tasks). This can make it very hard to track down issues stemming from unobserved exceptions. Setting this variable to 1 will force a garbage collection after each test method, increasing the chances of unobserved exceptions firing against their related tests.

Note that this adds a considerable overhead to test runs, especially on projects with large allocations. For osu! we see an overhead of around 80-100%. For this reason, it is disabled by default.

OSU_TESTS_NO_TIMEOUT

By default, AddUntilStep has a timeout to ensure tests don't run forever. Settings this variable to 1 will disable this timeout. This is useful when diagnosing deadlock scenarios, or to allow ample time to attach a debugger and check on the current state of the game in a fail case.

OSU_EXECUTION_MODE

Force an execution mode for test runs. Valid values are SingleThread and MultiThreaded. Default is MultiThreaded.

OSU_GRAPHICS_RENDERER

Selects the graphics renderer implementation. Valid values are:

• gl or opengl - the GLRenderer implementation.
  • Only supports the opengl graphics surface.
• veldrid - the VeldridRenderer implementation.

OSU_GRAPHICS_SURFACE

Selects the graphics surface that the renderer should use. Valid values are:

• opengl
• metal (only on Apple operating systems)
• direct3d11 (only on Windows operating systems)
• vulkan (except Apple operating systems)

OSU_GRAPHICS_NO_SSBO

Enables/disables use of Shader Storage Buffer Objects. When disabled, the game falls back to Uniform Buffer Objects that are more limited in functionality but more broadly supported.

Valid values are:

• 0 - Disabled
• 1 - Enabled

OSU_FRAME_STATISTICS_VIA_TOUCH

Whether to allow access to framework overlays via touch input. When set to 1 (default):

• Double-click on any area on the bottom right corner of the screen to cycle between frame statistics display (and also make it visible from hidden state).
• Tap with a single finger to expand the frame statistics display when in full state (similar to holding Ctrl).
• Tap with a second finger to freeze the frame statistics display (similar to holding Shift).

Note that this only works in debug builds. Disable for debug builds by setting to 0.