Precompile Shaders

Dependencies

M.dependencies = {'core_levels'}

Iterates through a predefined list of levels, loading each one with synchronous shader compilation to force all shaders to be precompiled and cached.

Overview

util_precompileShaders is a build-time utility that loads a fixed set of levels sequentially. By disabling async shader compilation, every shader encountered is compiled immediately. Once all levels are processed, the application quits. This is used in CI/build pipelines to warm the shader cache.

Extension path: lua/ge/extensions/util/precompileShaders.lua Dependencies: core_levels

Exports (M)

Internals

Level List

A hardcoded lookup table levelsToLoad contains ~21 level names (e.g. east_coast_usa, italy, utah, west_coast_usa). Only levels present in both core_levels.getList() and this table are processed.

Flow

1. onInit - filters available levels against levelsToLoad, calls Engine.Render.setAsyncShaderCompilation(false), loads the first level.
2. onClientStartMission - sets loaded = true when a level finishes loading.
3. onPreRender - when loaded is true, advances levelToLoad index. If all levels done, calls quit().

State Variables

• levels - filtered array of level data tables
• levelToLoad - current index (1-based)
• loaded - boolean, set true by onClientStartMission
• finished - boolean, stops processing in onPreRender

How It Works

1. Extension is loaded (typically via CLI argument).
2. onInit builds a filtered list of levels and starts loading the first.
3. Each level triggers onClientStartMission → next frame onPreRender advances to the next.
4. After the last level, the game exits via quit().

Lua Examples

-- Typically invoked via command-line, not runtime:
-- beamng.exe -onLevelLoad_ext "util/precompileShaders"

-- The extension auto-starts on load via onInit
extensions.load("util/precompileShaders")

Additional Exports

• M.onClientStartMission - (undocumented)
• M.onInit - (undocumented)
• M.onPreRender - (undocumented)

See Also

• Auto Annotation - Related reference
• Booster - Related reference
• Calibrate ESC - Related reference
• Game Engine Overview - Guide