Cursor

constructor

• new Cursor(type: CursorType): Cursor

  Create a system cursor; throw SFMLError if unsupported by the platform.

  Parameters

  type

  CursorType

  Returns

  Cursor

  Source & inheritance
• new Cursor(
      pixels: Uint8Array,
      size: Readonly<Vector2u>,
      hotspot: Readonly<Vector2u>,
  ): Cursor

  Create a cursor from RGBA8 pixels; size and click hotspot are measured in pixels. Throw SFMLError on failure.

  Parameters

  pixels

  Uint8Array

  size

  Readonly<Vector2u>

  hotspot

  Readonly<Vector2u>

  Returns

  Cursor

  Source & inheritance

Static ReadonlyType

StaticcreateFromPixels

• createFromPixels(
      pixels: Uint8Array,
      size: Readonly<Vector2u>,
      hotspot: Readonly<Vector2u>,
  ): undefined | Cursor

  Try to create a cursor from RGBA8 pixels; the hotspot must be within the dimensions. Return undefined if creation fails.

  Parameters

  pixels

  Uint8Array

  size

  Readonly<Vector2u>

  hotspot

  Readonly<Vector2u>

  Returns

  undefined | Cursor

  Source & inheritance

StaticcreateFromSystem

• createFromSystem(type: CursorType): undefined | Cursor

  Try to create a system cursor; return undefined if unsupported by the platform.

  Parameters

  type

  CursorType

  Returns

  undefined | Cursor

  Source & inheritance

Readonly[graphicsNative]