API reference
Preparing search index…

Native-owned SFML system interface with optional host virtuals.

Construction claims the setup environment. Selection must occur before initialization; the selected interface and window remain alive until shutdown. Unselected objects and callback cycles can be collected. Shutdown invalidates every interface, including unused setup objects.

Source & inheritance
Member directory11

Constructors

Accessors

Methods

Constructors

Accessors

  • get clock(): Float64Array

    Shared seconds input, with NaN selecting the native SFML clock.

    Returns

    Float64Array

    One-element native time view.

    Write clock[0] once before update. No JS callback or Addon call is needed for native time reads. Finite input must be nonnegative. The backing stores only this double, retains no window/callback, and survives shutdown.

    Source & inheritance

Methods

  • Read clipboard text; the default SFML backend converts Unicode to UTF-8.

    Returns

    string

    Clipboard text.

    Source & inheritance
  • Invoke native GetElapsedTime using shared input or the SFML clock.

    Returns

    number

    Elapsed nonnegative seconds.

    Normal event listeners may read time. System callbacks cannot reenter.

    Source & inheritance
  • Invoke native JoinPath.

    Parameters

    documentPath
    string

    Source filename, including its directory.

    resourcePath
    string

    Referenced resource path.

    Returns

    string

    Joined resource path.

    Source & inheritance
  • Invoke native LogMessage.

    Parameters

    type

    Native severity.

    message
    string

    Message text.

    Returns

    boolean

    Whether native execution should continue.

    Source & inheritance
  • Set clipboard text; the default SFML backend preserves Unicode via UTF-8.

    Parameters

    text
    string

    Clipboard UTF-8 text.

    Returns

    void
    Source & inheritance
  • Invoke native SetMouseCursor.

    Parameters

    name
    string

    Native cursor name.

    Returns

    void
    Source & inheritance

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