API reference
Preparing search index…

RenderWindow

A window supporting both Window operations and RenderTarget 2D drawing.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory61

Constructors

Properties

Methods

Constructors

Methods

  • Returns the created VkSurfaceKHR, or undefined when creation fails.

    Parameters

    instance
    bigint
    allocator
    bigint = 0n

    Returns

    undefined | bigint
    Source & inheritance
  • Called synchronously after an explicit create succeeds; derived hooks are not called during base construction with arguments.

    Returns

    void
    Source & inheritance
  • Called synchronously after SFML actually reports a size change, without consuming the corresponding Resized event.

    Returns

    void
    Source & inheritance
  • Submits queued draws and activates or deactivates the OpenGL context; returns whether it succeeded.

    Parameters

    active
    boolean = true

    Returns

    boolean
    Source & inheritance
  • Set the maximum display calls per second; 0 removes the frame-rate limit, and waiting occurs inside display.

    Parameters

    limit
    number

    Returns

    void
    Source & inheritance
  • Set the axis-change threshold for joystick movement events, from 0 to 100.

    Parameters

    threshold
    number

    Returns

    void
    Source & inheritance
  • Set whether to confine the mouse to the window, usually only effective while the window has focus.

    Parameters

    grabbed
    boolean

    Returns

    void
    Source & inheritance

Symbol members

"[graphicsNative]": NativeGraphicsHandle<"window">
Source & inheritance
  • Returns

    ReadonlySet<
        Readonly<
            Pick<
                Texture,
                | "getSize"
                | typeof graphicsNative
                | typeof textureId
                | typeof textureOwner
                | "copyToImage"
                | "isSmooth"
                | "isRepeated"
                | "isSrgb"
                | "getNativeHandle",
            >,
        >,
    >
    Source & inheritance

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