API reference
Preparing search index…

InitialiseOptions

Options for the process-wide RmlUi runtime.

interface InitialiseOptions {
    fileRoot?: string;
    highDpi?: boolean;
}
Source & inheritance
Member directory2

Properties

Properties

fileRoot?: string

Root directory to try first when opening resources.

Both /assets/a.png and assets/a.png resolve below this directory, then fall back to the original path. Relative roots resolve against the working directory. When omitted, RmlUi uses its default file interface. This option does not restrict filesystem access.

Source & inheritance
highDpi?: boolean

Enable the native Retina surface on macOS.

true

The window keeps its on-screen size; getSize(), events and texture capture then use physical pixels. Use RCSS dp units for stable UI sizing. Passing false preserves the existing surface. Once enabled, the surface stays enabled until the window closes, including after shutdown.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0