VideoMode

constructor

• new VideoMode(): VideoMode

  Create an empty mode with zero dimensions and color depth.

  Returns

  VideoMode

  Source & inheritance
• new VideoMode(size: Readonly<Vector2u>, bitsPerPixel?: number): VideoMode

  Create a mode with the specified pixel dimensions, defaulting to 32 bits per pixel.

  Parameters

  size

  Readonly<Vector2u>

  bitsPerPixelOptional

  number

  Returns

  VideoMode

  Source & inheritance
• new VideoMode(source: Readonly<VideoMode>): VideoMode

  Deep-copy a video mode.

  Parameters

  source

  Readonly<VideoMode>

  Returns

  VideoMode

  Source & inheritance

bitsPerPixel

size

• get size(): Vector2u

  The mode's pixel width and height; components can be modified directly.

  Returns

  Vector2u

  Source & inheritance
• set size(value: Readonly<Vector2u>): void

  Copy pixel dimensions into the current mode.

  Parameters

  value

  Readonly<Vector2u>

  Returns

  void

  Source & inheritance

isValid

• isValid(): boolean

  Test whether this mode can be used for a fullscreen window.

  Returns

  boolean

  Source & inheritance

StaticgetDesktopMode

• getDesktopMode(): VideoMode

  Return the video mode currently used by the desktop.

  Returns

  VideoMode

  Source & inheritance

StaticgetFullscreenModes

• getFullscreenModes(): VideoMode[]

  Return system-supported fullscreen modes in SFML's preference order.

  Returns

  VideoMode[]

  Source & inheritance