SDL.Video

Create a window with the given title and configuration.

Throws SDLException on failure.

Default configuration for windows. Use the record update syntax to override any of the defaults.

defaultWindow = WindowConfig
  { windowBorder          = True
  , windowHighDPI         = False
  , windowInputGrabbed    = False
  , windowMode            = Windowed
  , windowGraphicsContext = NoGraphicsContext
  , windowPosition        = Wherever
  , windowResizable       = False
  , windowInitialSize     = V2 800 600
  , windowVisible         = True
  }

Configuration of additional graphics context that will be created for window.

Can not be changed after window creation.

Destroy the given window. The Window handler may not be used afterwards.

Hide a window.

See SDL_HideWindow for C documentation.

Raise the window above other windows and set the input focus.

See SDL_RaiseWindow for C documentation.

Show a window.

See SDL_ShowWindow for C documentation.

Get or set the minimum size of a window's client area.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetWindowMinimumSize and SDL_GetWindowMinimumSize for C documentation.

Get or set the maximum size of a window's client area.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetWindowMaximumSize and SDL_GetWindowMaximumSize for C documentation.

Get or set the opacity of a window.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetWindowOpacity and SDL_GetWindowOpacity for C documentation.

Get or set the size of a window's client area. Values beyond the maximum supported size are clamped.

If window was created with windowHighDPI flag, this size may differ from the size in pixels. Use glGetDrawableSize or vkGetDrawableSize to get size in pixels.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetWindowSize and SDL_GetWindowSize for C documentation.

Get or set if the window should have a border.

This StateVar can be modified using $= and the current value retrieved with get.

Get or set the window's brightness, where 0.0 is completely dark and 1.0 is normal brightness.

Throws SDLException if the hardware does not support gamma correction, or if the system has run out of memory.

This StateVar can be modified using $= and the current value retrieved with get.

Gets or sets the gamma ramp for the display that owns a given window.

Note that the data for the gamma ramp - the V3 (Vector Word16) - must contain 256 element arrays. This triple is a set of translation vectors for each of the 16-bit red, green and blue channels.

This StateVar can be modified using $= and the current value retrieved with get.

Despite the name and signature, this method retrieves the gamma ramp of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel.

Get or set whether the mouse shall be confined to the window.

This StateVar can be modified using $= and the current value retrieved with get.

Change between window modes.

Throws SDLException on failure.

Get the position of the window.

Get the size of a window's borders (decorations) around the client area (top, left, bottom, right).

See SDL_GetWindowBordersSize for C documentation.

Set the icon for a window.

Set the position of the window.

Get or set the title of the window. If the window has no title, then an empty string is returned.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetWindowTitle and SDL_GetWindowTitle for C documentation.

Get or set the pointer to arbitrary user data associated with the given window and name.

This StateVar can be modified using $= and the current value retrieved with get.

Retrieve the configuration of the given window.

Note that NoGraphicsContext will be returned instead of potential OpenGL parameters used during the creation of the window.

Get the pixel format that is used for the given window.

Create a 2D software rendering context for the given surface.

See https://wiki.libsdl.org/SDL2/SDL_CreateSoftwareRenderer

Get the text from the clipboard.

Throws SDLException on failure.

Checks if the clipboard exists, and has some text in it.

Replace the contents of the clipboard with the given text.

Throws SDLException on failure.

Throws SDLException on failure.

Get or set whether to allow the screen to be blanked by a screen saver.

Screen savers are re-enabled, if needed, when SDL quits.

Show a simple message box with the given title and a message. Consider writing your messages to stderr too.

Throws SDLException if there are no available video targets.