API reference
Preparing search index…

Native RmlUi Debugger tools hosted in one context and inspecting another.

Requires an initialized runtime. Host removal or unloading all its documents shuts down the debugger. Target removal detaches inspection. All operations run natively; the debugger reads models through native reflection. Visibility uses upstream computed style; update the host after changing it.

Source & inheritance
Member directory5

Methods

Methods

  • Load the native debugger into a host, initially hidden.

    Parameters

    host

    Live host context; initially also the inspection target.

    Returns

    boolean

    Native success; false if already initialized or loading fails.

    Source & inheritance
  • Read native menu visibility, false when the debugger is not initialized.

    Returns

    boolean

    Native menu visibility.

    Source & inheritance
  • Select the context to inspect, or detach inspection with null.

    Parameters

    target
    null | Context

    Live target context, or null to remove the native hook.

    Returns

    boolean

    Upstream result; false when the debugger is not initialized.

    Source & inheritance
  • Change native menu visibility; does nothing before debugger initialization.

    Parameters

    visible
    boolean

    Strict boolean menu visibility.

    Returns

    void
    Source & inheritance
  • Release native debugger documents and listeners; repeated calls are safe.

    Returns

    void
    Source & inheritance

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