Windows

Windows

Window Manager in SplashKit can be used create, and manipulate graphics windows

Functions

Clear Window

clears a window to the specified color given in clr

Parameters:

Name	Type	Description
wind	Window	the Window to clear
clr	Color	the Color to clear the window to.

Signatures:

C++

void clear_window(window wind, color clr)

C#

public void Window.Clear(Color clr);
public static void SplashKit.ClearWindow(Window wind, Color clr);

Python

def clear_window(wind, clr):

Pascal

procedure ClearWindow(wind: Window; clr: Color)

---

Close All Windows

Releases all of the windows which have been loaded.

Signatures:

C++

void close_all_windows()

C#

public static void SplashKit.CloseAllWindows();

Python

def close_all_windows():

Pascal

procedure CloseAllWindows()

Usage:

See Implementations in Guides

• Get Started with SplashKit GPIO
• Reading Button Presses
• Modify PWM through button presses

---

Close Current Window

Closes and frees the current window.

Signatures:

C++

void close_current_window()

C#

public static void SplashKit.CloseCurrentWindow();

Python

def close_current_window():

Pascal

procedure CloseCurrentWindow()

---

Close Window

Note

This function is overloaded. The following versions exist:

• Close Window (name: string)
• Close Window (wind: window)

Close Window

Closes and frees the graphics window identified by name.

Parameters:

Name	Type	Description
name	String	The name (caption) of the window to close

Signatures:

C++

void close_window(const string &name)

C#

public static void SplashKit.CloseWindow(string name);

Python

def close_window_named(name):

Pascal

procedure CloseWindow(const name: String)

---

Close Window

Closes and frees the graphics window supplied in wind.

Parameters:

Name	Type	Description
wind	Window	The window to close

Signatures:

C++

void close_window(window wind)

C#

public void Window.Close();
public static void SplashKit.CloseWindow(Window wind);

Python

def close_window(wind):

Pascal

procedure CloseWindow(wind: Window)

---

Current Window

Returns the window that you are currently interacting with. This will be the default window for drawing options, and events.

Return Type: Window

Signatures:

C++

window current_window()

C#

public static Window SplashKit.CurrentWindow();

Python

def current_window():

Pascal

function CurrentWindow(): Window

---

Current Window Has Border

Indicate if the current window has a border.

Return Type: Boolean

Signatures:

C++

bool current_window_has_border()

C#

public static bool SplashKit.CurrentWindowHasBorder();

Python

def current_window_has_border():

Pascal

function CurrentWindowHasBorder(): Boolean

---

Current Window Height

Returns the height of the current window.

Return Type: Integer

Signatures:

C++

int current_window_height()

C#

public static int SplashKit.CurrentWindowHeight();

Python

def current_window_height():

Pascal

function CurrentWindowHeight(): Integer

---

Current Window Is Fullscreen

Is the current window currently fullscreen?

Return Type: Boolean

Signatures:

C++

bool current_window_is_fullscreen()

C#

public static bool SplashKit.CurrentWindowIsFullscreen();

Python

def current_window_is_fullscreen():

Pascal

function CurrentWindowIsFullscreen(): Boolean

---

Current Window Position

The location of the current window.

Return Type: Point 2d

Signatures:

C++

point_2d current_window_position()

C#

public static Point2D SplashKit.CurrentWindowPosition();

Python

def current_window_position():

Pascal

function CurrentWindowPosition(): Point2D

---

Current Window Toggle Border

Toggle the current window border.

Signatures:

C++

void current_window_toggle_border()

C#

public static void SplashKit.CurrentWindowToggleBorder();

Python

def current_window_toggle_border():

Pascal

procedure CurrentWindowToggleBorder()

---

Current Window Toggle Fullscreen

Toggle the fullscreen property of the current window

Signatures:

C++

void current_window_toggle_fullscreen()

C#

public static void SplashKit.CurrentWindowToggleFullscreen();

Python

def current_window_toggle_fullscreen():

Pascal

procedure CurrentWindowToggleFullscreen()

---

Current Window Width

Returns the width of the current window.

Return Type: Integer

Signatures:

C++

int current_window_width()

C#

public static int SplashKit.CurrentWindowWidth();

Python

def current_window_width():

Pascal

function CurrentWindowWidth(): Integer

---

Current Window X

The x location of the current window on the displays.

Return Type: Integer

Signatures:

C++

int current_window_x()

C#

public static int SplashKit.CurrentWindowX();

Python

def current_window_x():

Pascal

function CurrentWindowX(): Integer

---

Current Window Y

The y location of the current window on the displays.

Return Type: Integer

Signatures:

C++

int current_window_y()

C#

public static int SplashKit.CurrentWindowY();

Python

def current_window_y():

Pascal

function CurrentWindowY(): Integer

---

Has Window

Determines if SplashKit has a window loaded with the supplied name. This checks against all windows loaded, those loaded without a name are assigned the filename as a default. If this returns false, you may want to use load_window to load in a specific window and give it the desired name.

Parameters:

Name	Type	Description
caption	String	The name of the window to check for.

Return Type: Boolean

Signatures:

C++

bool has_window(string caption)

C#

public static bool SplashKit.HasWindow(string caption);

Python

def has_window(caption):

Pascal

function HasWindow(caption: String): Boolean

---

Is Current Window

Check if the requested window is the current window.

Parameters:

Name	Type	Description
wind	Window	The window to check

Return Type: Boolean

Signatures:

C++

bool is_current_window(window wind)

C#

public bool Window.IsCurrentWindow { get }
public static bool SplashKit.IsCurrentWindow(Window wind);

Python

def is_current_window(wind):

Pascal

function IsCurrentWindow(wind: Window): Boolean

---

Move Current Window To

Move the current window to the new location on the displays.

Parameters:

Name	Type	Description
x	Integer	The new x location
y	Integer	The new y location

Signatures:

C++

void move_current_window_to(int x, int y)

C#

public static void SplashKit.MoveCurrentWindowTo(int x, int y);

Python

def move_current_window_to(x, y):

Pascal

procedure MoveCurrentWindowTo(x: Integer; y: Integer)

---

Move Window To

Note

This function is overloaded. The following versions exist:

• Move Window To (name: string, x: int, y: int)
• Move Window To (wind: window, x: int, y: int)

Move Window To

Move the window to the new location on the displays.

Parameters:

Name	Type	Description
name	String	The name of the window to move
x	Integer	The new x location
y	Integer	The new y location

Signatures:

C++

void move_window_to(const string &name, int x, int y)

C#

public static void SplashKit.MoveWindowTo(string name, int x, int y);

Python

def move_window_to_named(name, x, y):

Pascal

procedure MoveWindowTo(const name: String; x: Integer; y: Integer)

---

Move Window To

Move the window to the new location on the displays.

Parameters:

Name	Type	Description
wind	Window	the window to move.
x	Integer	The new x location
y	Integer	The new y location

Signatures:

C++

void move_window_to(window wind, int x, int y)

C#

public void Window.MoveTo(int x, int y);
public static void SplashKit.MoveWindowTo(Window wind, int x, int y);

Python

def move_window_to(wind, x, y):

Pascal

procedure MoveWindowTo(wind: Window; x: Integer; y: Integer)

---

Open Window

Opens a new graphics window. The supplied caption is used to name and identify the window. The supplied width and height indicate the size of the window. The window can be retrieved by passing caption to the Window Named function.

Parameters:

Name	Type	Description
caption	String	The title of the window. If a window with this caption already exists, SplashKit will alter the caption to ensure that it is unique.
width	Integer	The width of the window
height	Integer	The height of the window

Return Type: Window

Signatures:

C++

window open_window(string caption, int width, int height)

C#

public static Window SplashKit.OpenWindow(string caption, int width, int height);
public Window(string caption, int width, int height);

Python

def open_window(caption, width, height):

Pascal

function OpenWindow(caption: String; width: Integer; height: Integer): Window

Usage:

See Implementations in Guides

• Using Animations in SplashKit
• Drawing using Procedures
• Reading Text
• Getting Started Creating User Interfaces
• Get Started with SplashKit GPIO
• Reading Button Presses
• Modify PWM through button presses

---

Refresh Window

Note

This function is overloaded. The following versions exist:

• Refresh Window (wind: window)
• Refresh Window (wind: window, target_fps: unsigned int)

Refresh Window

Refreshes the window wind.

Parameters:

Name	Type	Description
wind	Window	the Window to refresh.

Signatures:

C++

void refresh_window(window wind)

C#

public void Window.Refresh();
public static void SplashKit.RefreshWindow(Window wind);

Python

def refresh_window(wind):

Pascal

procedure RefreshWindow(wind: Window)

Usage:

See Implementations in Guides

• Using Mouse Inputs

---

Refresh Window

Refreshes the window wind.

Parameters:

Name	Type	Description
wind	Window	the Window to refresh.
target_fps	unsigned int	the desired framerate

Signatures:

C++

void refresh_window(window wind, unsigned int target_fps)

C#

public void Window.Refresh(uint targetFps);
public static void SplashKit.RefreshWindow(Window wind, uint targetFps);

Python

def refresh_window_with_target_fps(wind, target_fps):

Pascal

procedure RefreshWindow(wind: Window; targetFps: Cardinal)

---

Resize Current Window

Change the size of the current window.

Parameters:

Name	Type	Description
width	Integer	Its new width
height	Integer	Its new height

Signatures:

C++

void resize_current_window(int width, int height)

C#

public static void SplashKit.ResizeCurrentWindow(int width, int height);

Python

def resize_current_window(width, height):

Pascal

procedure ResizeCurrentWindow(width: Integer; height: Integer)

---

Resize Window

Change the size of the window.

Parameters:

Name	Type	Description
wnd	Window	The window to change.
width	Integer	Its new width
height	Integer	Its new height

Signatures:

C++

void resize_window(window wnd, int width, int height)

C#

public void Window.Resize(int width, int height);
public static void SplashKit.ResizeWindow(Window wnd, int width, int height);

Python

def resize_window(wnd, width, height):

Pascal

procedure ResizeWindow(wnd: Window; width: Integer; height: Integer)

---

Set Current Window

Note

This function is overloaded. The following versions exist:

• Set Current Window (name: string)
• Set Current Window (wind: window)

Set Current Window

Set the current window to the window with the supplied caption.

Parameters:

Name	Type	Description
name	String	The caption of the new current window.

Signatures:

C++

void set_current_window(const string &name)

C#

public static void SplashKit.SetCurrentWindow(string name);

Python

def set_current_window_named(name):

Pascal

procedure SetCurrentWindow(const name: String)

---

Set Current Window

Change the current window. Use this so that you can draw to different windows by default.

Parameters:

Name	Type	Description
wind	Window	The new current window

Signatures:

C++

void set_current_window(window wind)

C#

public void Window.MakeCurrent();
public static void SplashKit.SetCurrentWindow(Window wind);

Python

def set_current_window(wind):

Pascal

procedure SetCurrentWindow(wind: Window)

---

Window Caption

The caption of the window.

Parameters:

Name	Type	Description
wind	Window	The window

Return Type: String

Signatures:

C++

string window_caption(window wind)

C#

public string Window.Caption { get }
public static string SplashKit.WindowCaption(Window wind);

Python

def window_caption(wind):

Pascal

function WindowCaption(wind: Window): String

---

Window Close Requested

Note

This function is overloaded. The following versions exist:

• Window Close Requested (name: string)
• Window Close Requested (wind: window)

Window Close Requested

Checks all opened windows in the current program to determin if a window with the name name is currently open, and will close a window if one is found.

Parameters:

Name	Type	Description
name	String	The name of the window to close

Return Type: Boolean

Signatures:

C++

bool window_close_requested(const string &name)

C#

public static bool SplashKit.WindowCloseRequested(string name);

Python

def window_close_requested_named(name):

Pascal

function WindowCloseRequested(const name: String): Boolean

---

Window Close Requested

Closes the window given in wind

Parameters:

Name	Type	Description
wind	Window	the Window to be closed

Return Type: Boolean

Signatures:

C++

bool window_close_requested(window wind)

C#

public bool Window.CloseRequested { get }
public static bool SplashKit.WindowCloseRequested(Window wind);

Python

def window_close_requested(wind):

Pascal

function WindowCloseRequested(wind: Window): Boolean

Usage:

See Implementations in Guides

• Using Mouse Inputs

---

Window Has Border

Note

This function is overloaded. The following versions exist:

• Window Has Border (name: string)
• Window Has Border (wnd: window)

Window Has Border

Indicate if the window has a border.

Parameters:

Name	Type	Description
name	String	The name of the window

Return Type: Boolean

Signatures:

C++

bool window_has_border(const string &name)

C#

public static bool SplashKit.WindowHasBorder(string name);

Python

def window_has_border_named(name):

Pascal

function WindowHasBorder(const name: String): Boolean

---

Window Has Border

Indicate if the window has a border.

Parameters:

Name	Type	Description
wnd	Window	The window

Return Type: Boolean

Signatures:

C++

bool window_has_border(window wnd)

C#

public bool Window.HasBorder { get }
public static bool SplashKit.WindowHasBorder(Window wnd);

Python

def window_has_border(wnd):

Pascal

function WindowHasBorder(wnd: Window): Boolean

---

Window Has Focus

Indicates if the window has focus.

Parameters:

Name	Type	Description
wind	Window	The window

Return Type: Boolean

Signatures:

C++

bool window_has_focus(window wind)

C#

public bool Window.HasFocus { get }
public static bool SplashKit.WindowHasFocus(Window wind);

Python

def window_has_focus(wind):

Pascal

function WindowHasFocus(wind: Window): Boolean

---

Window Height

Note

This function is overloaded. The following versions exist:

• Window Height (name: string)
• Window Height (wind: window)

Window Height

Returns the height of the window with the indicated name in pixels.

Parameters:

Name	Type	Description
name	String	The name of the window

Return Type: Integer

Signatures:

C++

int window_height(const string &name)

C#

public static int SplashKit.WindowHeight(string name);

Python

def window_height_named(name):

Pascal

function WindowHeight(const name: String): Integer

---

Window Height

Returns the height of the window in pixels.

Parameters:

Name	Type	Description
wind	Window	The window

Return Type: Integer

Signatures:

C++

int window_height(window wind)

C#

public int Window.Height { get }
public static int SplashKit.WindowHeight(Window wind);

Python

def window_height(wind):

Pascal

function WindowHeight(wind: Window): Integer

---

Window Is Fullscreen

Note

This function is overloaded. The following versions exist:

• Window Is Fullscreen (name: string)
• Window Is Fullscreen (wnd: window)

Window Is Fullscreen

Is the window currently fullscreen?

Parameters:

Name	Type	Description
name	String	The name of the window to check

Return Type: Boolean

Signatures:

C++

bool window_is_fullscreen(const string &name)

C#

public static bool SplashKit.WindowIsFullscreen(string name);

Python

def window_is_fullscreen_named(name):

Pascal

function WindowIsFullscreen(const name: String): Boolean

---

Window Is Fullscreen

Is the window currently fullscreen?

Parameters:

Name	Type	Description
wnd	Window	The window to check

Return Type: Boolean

Signatures:

C++

bool window_is_fullscreen(window wnd)

C#

public bool Window.IsFullscreen { get }
public static bool SplashKit.WindowIsFullscreen(Window wnd);

Python

def window_is_fullscreen(wnd):

Pascal

function WindowIsFullscreen(wnd: Window): Boolean

---

Window Named

Returns an opened Window with the given name caption, if a window with name caption is found.

Parameters:

Name	Type	Description
caption	String	the String name of the window.

Return Type: Window

Signatures:

C++

window window_named(string caption)

C#

public static Window SplashKit.WindowNamed(string caption);

Python

def window_named(caption):

Pascal

function WindowNamed(caption: String): Window

---

Window Position

Note

This function is overloaded. The following versions exist:

• Window Position (name: string)
• Window Position (wnd: window)

Window Position

The location of the window.

Parameters:

Name	Type	Description
name	String	The name of the window.

Return Type: Point 2d

Signatures:

C++

point_2d window_position(const string &name)

C#

public static Point2D SplashKit.WindowPosition(string name);

Python

def window_position_named(name):

Pascal

function WindowPosition(const name: String): Point2D

---

Window Position

The location of the window.

Parameters:

Name	Type	Description
wnd	Window	The window.

Return Type: Point 2d

Signatures:

C++

point_2d window_position(window wnd)

C#

public Point2D Window.Position { get }
public static Point2D SplashKit.WindowPosition(Window wnd);

Python

def window_position(wnd):

Pascal

function WindowPosition(wnd: Window): Point2D

---

Window Set Icon

Sets the icon of the current window.

Parameters:

Name	Type	Description
wind	Window	The window to change the icon of
bmp	Bitmap	The image with the details to show in the icon

Signatures:

C++

void window_set_icon(window wind, bitmap bmp)

C#

public void Window.Icon { set }
public static void SplashKit.WindowSetIcon(Window wind, Bitmap bmp);

Python

def window_set_icon(wind, bmp):

Pascal

procedure WindowSetIcon(wind: Window; bmp: Bitmap)

---

Window Toggle Border

Note

This function is overloaded. The following versions exist:

• Window Toggle Border (name: string)
• Window Toggle Border (wnd: window)

Window Toggle Border

Toggle the window border.

Parameters:

Name	Type	Description
name	String	The name of the window to change

Signatures:

C++

void window_toggle_border(const string &name)

C#

public static void SplashKit.WindowToggleBorder(string name);

Python

def window_toggle_border_named(name):

Pascal

procedure WindowToggleBorder(const name: String)

---

Window Toggle Border

Toggle the window border.

Parameters:

Name	Type	Description
wnd	Window	The window to change

Signatures:

C++

void window_toggle_border(window wnd)

C#

public void Window.ToggleBorder();
public static void SplashKit.WindowToggleBorder(Window wnd);

Python

def window_toggle_border(wnd):

Pascal

procedure WindowToggleBorder(wnd: Window)

---

Window Toggle Fullscreen

Note

This function is overloaded. The following versions exist:

• Window Toggle Fullscreen (name: string)
• Window Toggle Fullscreen (wnd: window)

Window Toggle Fullscreen

Toggle the fullscreen property of the window

Parameters:

Name	Type	Description
name	String	The name of the window to change

Signatures:

C++

void window_toggle_fullscreen(const string &name)

C#

public static void SplashKit.WindowToggleFullscreen(string name);

Python

def window_toggle_fullscreen_named(name):

Pascal

procedure WindowToggleFullscreen(const name: String)

---

Window Toggle Fullscreen

Toggle the fullscreen property of the window

Parameters:

Name	Type	Description
wnd	Window	The window to change

Signatures:

C++

void window_toggle_fullscreen(window wnd)

C#

public void Window.ToggleFullscreen();
public static void SplashKit.WindowToggleFullscreen(Window wnd);

Python

def window_toggle_fullscreen(wnd):

Pascal

procedure WindowToggleFullscreen(wnd: Window)

---

Window Width

Note

This function is overloaded. The following versions exist:

• Window Width (name: string)
• Window Width (wind: window)

Window Width

Returns the width of the window with the indicated name in pixels.

Parameters:

Name	Type	Description
name	String	The name of the window

Return Type: Integer

Signatures:

C++

int window_width(const string &name)

C#

public static int SplashKit.WindowWidth(string name);

Python

def window_width_named(name):

Pascal

function WindowWidth(const name: String): Integer

---

Window Width

Returns the width of the window in pixels.

Parameters:

Name	Type	Description
wind	Window	The window

Return Type: Integer

Signatures:

C++

int window_width(window wind)

C#

public int Window.Width { get }
public static int SplashKit.WindowWidth(Window wind);

Python

def window_width(wind):

Pascal

function WindowWidth(wind: Window): Integer

---

Window With Focus

Returns the window that the user currently has selected. This may be different to the current window.

Return Type: Window

Signatures:

C++

window window_with_focus()

C#

public static Window SplashKit.WindowWithFocus();

Python

def window_with_focus():

Pascal

function WindowWithFocus(): Window

---

Window X

Note

This function is overloaded. The following versions exist:

• Window X (name: string)
• Window X (wnd: window)

Window X

The x location of the window on the displays.

Parameters:

Name	Type	Description
name	String	The name of the window

Return Type: Integer

Signatures:

C++

int window_x(const string &name)

C#

public static int SplashKit.WindowX(string name);

Python

def window_x_named(name):

Pascal

function WindowX(const name: String): Integer

---

Window X

The x location of the window on the displays.

Parameters:

Name	Type	Description
wnd	Window	The window

Return Type: Integer

Signatures:

C++

int window_x(window wnd)

C#

public int Window.X { get }
public static int SplashKit.WindowX(Window wnd);

Python

def window_x(wnd):

Pascal

function WindowX(wnd: Window): Integer

---

Window Y

Note

This function is overloaded. The following versions exist:

• Window Y (name: string)
• Window Y (wnd: window)

Window Y

The y location of the window on the displays.

Parameters:

Name	Type	Description
name	String	The name of the window

Return Type: Integer

Signatures:

C++

int window_y(const string &name)

C#

public static int SplashKit.WindowY(string name);

Python

def window_y_named(name):

Pascal

function WindowY(const name: String): Integer

---

Window Y

The y location of the window on the displays.

Parameters:

Name	Type	Description
wnd	Window	The window

Return Type: Integer

Signatures:

C++

int window_y(window wnd)

C#

public int Window.Y { get }
public static int SplashKit.WindowY(Window wnd);

Python

def window_y(wnd):

Pascal

function WindowY(wnd: Window): Integer

---

Types

Window

The Window type is used to refer to a window that you have opened in SplashKit. You create new Windows using Open Window and they can be closed using Close Window.

• opened with Open Window

• and must be released using Close Window (to close a specific window) or delete_all_windows (to close all loaded windows).

---