API reference
Preparing search index…
  • Initialise RmlUi with SFML-backed system and render interfaces.

    Parameters

    window
    RenderWindow

    Open sfml.js render window.

    options

    Resource and display options for first initialisation.

    Returns

    boolean

    Whether initialisation succeeded.

    One process-wide runtime has a default render window. Repeated calls return true without replacing the window or options. Keep the window open until shutdown; create contexts afterwards using its physical pixel size. A system selected with setSystemInterface before initialization is retained; otherwise a native SFML system interface is installed. Runtime operations belong to the initialising Node environment and thread. Other workers may import the native module and read its version, but cannot access or shut down the owner's runtime.

    TypeError for a non-RenderWindow; Error if Retina setup fails.

    Source & inheritance

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