Brine2DOptions Class
Configuration options for Brine2D game engine.
public sealed class Brine2DOptions
Inheritance System.Object → Brine2DOptions
| Properties | |
|---|---|
| Assets | Asset loader configuration. |
| Audio | Audio configuration. |
| ECS | ECS configuration. |
| ForceShutdownGracePeriodSeconds | Time in seconds to wait for the game thread's finally block to complete after a forced shutdown is triggered. Default: 2 seconds. |
| GameThreadPriority | Scheduling priority of the dedicated game thread. Raise to System.Threading.ThreadPriority.AboveNormal on CPU-bound workloads for tighter frame-timing. Avoid System.Threading.ThreadPriority.Highest; it can starve OS threads and cause system instability on some platforms. Default: System.Threading.ThreadPriority.Normal. |
| Headless | Run in headless mode (no window, input, audio, or rendering). Useful for dedicated servers or automated testing. |
| LoadingScreenMinimumDisplayMs | Minimum time in milliseconds a loading screen stays visible after the scene is ready. Prevents loading screens from flashing on very fast loads. Default: 200. Set to 0 to disable. |
| Rendering | Rendering configuration. |
| ShutdownTimeout | Gets ShutdownTimeoutSeconds as a System.TimeSpan. |
| ShutdownTimeoutSeconds | Time in seconds to wait for the game thread to exit gracefully during disposal. If the thread does not exit within this window, a forced shutdown is triggered. Default: 5 seconds. |
| Window | Window configuration. |
| Methods | |
|---|---|
| Validate() | Validates all options using DataAnnotations. Called automatically by Build() and at host startup. Subsequent calls short-circuit if the first validation succeeded. |