Interface

Interface

SplashKit Interface provides functions to create user interfaces, with elements such as draggable panels, buttons and text boxes.

Functions

Add Column

Adds a column to the current layout with width width. - Positive values of width just specify the width in pixels. - 0 means use the default control width - not always a good choice. - Negative values specify filling to the right until width + 1 pixels away from the edge. - e.g -1 fills entirely to the right, while -20 leaves a 19 pixel gap on the right.

Parameters:

Name	Type	Description
width	Integer	Width of the column in pixels

Signatures:

C++

void add_column(int width)

C#

public static void Interface.AddColumn(int width);
public static void SplashKit.AddColumn(int width);

Python

def add_column(width):

Pascal

procedure AddColumn(width: Integer)

---

Add Column Relative

Adds a column to the current layout with width width percentage of the container’s width.

Parameters:

Name	Type	Description
width	Double	Percentage of the container’s width (between 0 and 1)

Signatures:

C++

void add_column_relative(double width)

C#

public static void Interface.AddColumnRelative(double width);
public static void SplashKit.AddColumnRelative(double width);

Python

def add_column_relative(width):

Pascal

procedure AddColumnRelative(width: Double)

---

Bitmap Button

Note

This function is overloaded. The following versions exist:

• Bitmap Button (bmp: bitmap)
• Bitmap Button (bmp: bitmap, rect: rectangle)
• Bitmap Button (bmp: bitmap, rect: rectangle, opts: drawing_options)
• Bitmap Button (bmp: bitmap, opts: drawing_options)
• Bitmap Button (label: string, bmp: bitmap)
• Bitmap Button (label: string, bmp: bitmap, opts: drawing_options)

Bitmap Button

Creates a button with a bitmap in it, and no label. Returns whether the button was clicked.

Parameters:

Name	Type	Description
bmp	Bitmap	The bitmap to show inside the button

Return Type: Boolean

Signatures:

C++

bool bitmap_button(bitmap bmp)

C#

public static bool Interface.BitmapButton(Bitmap bmp);
public static bool SplashKit.BitmapButton(Bitmap bmp);

Python

def bitmap_button(bmp):

Pascal

function BitmapButton(bmp: Bitmap): Boolean

---

Bitmap Button

Creates a button with a bitmap in it at a specific position on screen. Returns whether the button was clicked.

Parameters:

Name	Type	Description
bmp	Bitmap	The bitmap to show inside the button
rect	Rectangle	The rectangle to display the button in

Return Type: Boolean

Signatures:

C++

bool bitmap_button(bitmap bmp, const rectangle &rect)

C#

public static bool Interface.BitmapButton(Bitmap bmp, Rectangle rect);
public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect);

Python

def bitmap_button_at_position(bmp, rect):

Pascal

function BitmapButton(bmp: Bitmap; const rect: Rectangle): Boolean

---

Bitmap Button

Creates a button with a bitmap in it at a specific position on screen. Returns whether the button was clicked.

Parameters:

Name	Type	Description
bmp	Bitmap	The bitmap to show inside the button
rect	Rectangle	The rectangle to display the button in
opts	Drawing Options	The drawing options

Return Type: Boolean

Signatures:

C++

bool bitmap_button(bitmap bmp, const rectangle &rect, drawing_options opts)

C#

public static bool Interface.BitmapButton(Bitmap bmp, Rectangle rect, DrawingOptions opts);
public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect, DrawingOptions opts);

Python

def bitmap_button_at_position_with_options(bmp, rect, opts):

Pascal

function BitmapButton(bmp: Bitmap; const rect: Rectangle; opts: DrawingOptions): Boolean

---

Bitmap Button

Creates a button with a bitmap in it, and no label. Returns whether the button was clicked.

Parameters:

Name	Type	Description
bmp	Bitmap	The bitmap to show inside the button
opts	Drawing Options	The drawing options

Return Type: Boolean

Signatures:

C++

bool bitmap_button(bitmap bmp, drawing_options opts)

C#

public static bool Interface.BitmapButton(Bitmap bmp, DrawingOptions opts);
public static bool SplashKit.BitmapButton(Bitmap bmp, DrawingOptions opts);

Python

def bitmap_button_with_options(bmp, opts):

Pascal

function BitmapButton(bmp: Bitmap; opts: DrawingOptions): Boolean

---

Bitmap Button

Creates a button with a bitmap in it and a label. Returns whether the button was clicked.

Parameters:

Name	Type	Description
label	String	The label to show in front of the button
bmp	Bitmap	The bitmap to show inside the button

Return Type: Boolean

Signatures:

C++

bool bitmap_button(const string &label, bitmap bmp)

C#

public static bool Interface.BitmapButton(string label, Bitmap bmp);
public static bool SplashKit.BitmapButton(string label, Bitmap bmp);

Python

def bitmap_button_labeled(label, bmp):

Pascal

function BitmapButton(const label: String; bmp: Bitmap): Boolean

---

Bitmap Button

Creates a button with a bitmap in it and a label. Returns whether the button was clicked.

Parameters:

Name	Type	Description
label	String	The label to show in front of the button
bmp	Bitmap	The bitmap to show inside the button
opts	Drawing Options	The drawing options

Return Type: Boolean

Signatures:

C++

bool bitmap_button(const string &label, bitmap bmp, drawing_options opts)

C#

public static bool Interface.BitmapButton(string label, Bitmap bmp, DrawingOptions opts);
public static bool SplashKit.BitmapButton(string label, Bitmap bmp, DrawingOptions opts);

Python

def bitmap_button_labeled_with_options(label, bmp, opts):

Pascal

function BitmapButton(const label: String; bmp: Bitmap; opts: DrawingOptions): Boolean

---

Button

Note

This function is overloaded. The following versions exist:

• Button (text: string, rect: rectangle)
• Button (text: string)
• Button (label: string, text: string)

Button

Creates a button at a specific position on screen. Returns whether the button was clicked.

Parameters:

Name	Type	Description
text	String	The text to show inside the button
rect	Rectangle	The rectangle to display the button in

Return Type: Boolean

Signatures:

C++

bool button(const string &text, const rectangle &rect)

C#

public static bool Interface.Button(string text, Rectangle rect);
public static bool SplashKit.Button(string text, Rectangle rect);

Python

def button_at_position(text, rect):

Pascal

function Button(const text: String; const rect: Rectangle): Boolean

---

Button

Creates a button without a label. Returns whether the button was clicked.

Parameters:

Name	Type	Description
text	String	The text to show inside the button

Return Type: Boolean

Signatures:

C++

bool button(const string &text)

C#

public static bool Interface.Button(string text);
public static bool SplashKit.Button(string text);

Python

def button(text):

Pascal

function Button(const text: String): Boolean

---

Button

Creates a button with a label. Returns whether the button was clicked. Example usage: c++ // Test if clicked: if (button("Button 1", "Click me!")) { // do stuff.. }

Parameters:

Name	Type	Description
label	String	The label to show in front of the button
text	String	The text to show inside the button

Return Type: Boolean

Signatures:

C++

bool button(const string &label, const string &text)

C#

public static bool Interface.Button(string label, string text);
public static bool SplashKit.Button(string label, string text);

Python

def button_labeled(label, text):

Pascal

function Button(const label: String; const text: String): Boolean

---

Checkbox

Note

This function is overloaded. The following versions exist:

• Checkbox (text: string, value: bool, rect: rectangle)
• Checkbox (text: string, value: bool)
• Checkbox (label: string, text: string, value: bool)

Checkbox

Creates a checkbox at a specific position on screen. Returns the updated value of the checkbox.

Parameters:

Name	Type	Description
text	String	The text to show next to the checkbox
value	Boolean	The current value of the checkbox
rect	Rectangle	The rectangle to display the checkbox in

Return Type: Boolean

Signatures:

C++

bool checkbox(const string &text, const bool &value, const rectangle &rect)

C#

public static bool Interface.Checkbox(string text, bool value, Rectangle rect);
public static bool SplashKit.Checkbox(string text, bool value, Rectangle rect);

Python

def checkbox_at_position(text, value, rect):

Pascal

function Checkbox(const text: String; const value: Boolean; const rect: Rectangle): Boolean

---

Checkbox

Creates a checkbox. Returns the updated value of the checkbox.

Parameters:

Name	Type	Description
text	String	The text to show next to the checkbox
value	Boolean	The current value of the checkbox

Return Type: Boolean

Signatures:

C++

bool checkbox(const string &text, const bool &value)

C#

public static bool Interface.Checkbox(string text, bool value);
public static bool SplashKit.Checkbox(string text, bool value);

Python

def checkbox(text, value):

Pascal

function Checkbox(const text: String; const value: Boolean): Boolean

---

Checkbox

Creates a checkbox with a label. Returns the updated value of the checkbox. Example usage: c++ my_bool = checkbox("Checkbox 1", "Enabled?", my_bool);

Parameters:

Name	Type	Description
label	String	The label to show in front of the checkbox
text	String	The text to show next to the checkbox
value	Boolean	The current value of the checkbox

Return Type: Boolean

Signatures:

C++

bool checkbox(const string &label, const string &text, const bool &value)

C#

public static bool Interface.Checkbox(string label, string text, bool value);
public static bool SplashKit.Checkbox(string label, string text, bool value);

Python

def checkbox_labeled(label, text, value):

Pascal

function Checkbox(const label: String; const text: String; const value: Boolean): Boolean

---

Color Slider

Note

This function is overloaded. The following versions exist:

• Color Slider (clr: color, rect: rectangle)
• Color Slider (clr: color)
• Color Slider (label: string, clr: color)

Color Slider

Creates a set of RGBA sliders to adjust a color, at a specific position on screen. Returns the updated color value of the slider.

Parameters:

Name	Type	Description
clr	Color	The current value of the color slider
rect	Rectangle	The rectangle to display the slider in.

Return Type: Color

Signatures:

C++

color color_slider(const color &clr, const rectangle &rect)

C#

public static Color Interface.ColorSlider(Color clr, Rectangle rect);
public static Color SplashKit.ColorSlider(Color clr, Rectangle rect);

Python

def color_slider_at_position(clr, rect):

Pascal

function ColorSlider(const clr: Color; const rect: Rectangle): Color

---

Color Slider

Creates a set of RGBA sliders to adjust a color. Returns the updated color value of the slider.

Parameters:

Name	Type	Description
clr	Color	The current value of the color slider

Return Type: Color

Signatures:

C++

color color_slider(const color &clr)

C#

public static Color Interface.ColorSlider(Color clr);
public static Color SplashKit.ColorSlider(Color clr);

Python

def color_slider(clr):

Pascal

function ColorSlider(const clr: Color): Color

---

Color Slider

Creates a set of RGBA sliders to adjust a color, with a label. Returns the updated color value of the slider. Example usage: c++ my_color = color_slider("Player Color", my_color);

Parameters:

Name	Type	Description
label	String	The label to show in front of the slider
clr	Color	The current value of the color slider

Return Type: Color

Signatures:

C++

color color_slider(const string &label, const color &clr)

C#

public static Color Interface.ColorSlider(string label, Color clr);
public static Color SplashKit.ColorSlider(string label, Color clr);

Python

def color_slider_labeled(label, clr):

Pascal

function ColorSlider(const label: String; const clr: Color): Color

---

Disable Interface

Disables the interface temporarily. Elements created after this function will appear disabled and cannot be interacted with.

Signatures:

C++

void disable_interface()

C#

public static void Interface.DisableInterface();
public static void SplashKit.DisableInterface();

Python

def disable_interface():

Pascal

procedure DisableInterface()

---

Draw Interface

Draws the user interface that all the previous calls (such as Start Panel, Button, etc) have created. Make sure to call this! Without calling it, the interface won’t be visible.

Signatures:

C++

void draw_interface()

C#

public static void Interface.DrawInterface();
public static void SplashKit.DrawInterface();

Python

def draw_interface():

Pascal

procedure DrawInterface()

---

Enable Interface

Re-enables the interface, reverses the effects of disabling the interface.

Signatures:

C++

void enable_interface()

C#

public static void Interface.EnableInterface();
public static void SplashKit.EnableInterface();

Python

def enable_interface():

Pascal

procedure EnableInterface()

---

End Inset

Finishes the creation of an inset area.

Parameters:

Name	Type	Description
name	String	The area’s name - must match with Start Inset

Signatures:

C++

void end_inset(const string &name)

C#

public static void Interface.EndInset(string name);
public static void SplashKit.EndInset(string name);

Python

def end_inset(name):

Pascal

procedure EndInset(const name: String)

---

End Panel

Finishes the creation of a panel.

Parameters:

Name	Type	Description
name	String	The name shown in the panel’s titlebar - must match with Start Panel

Signatures:

C++

void end_panel(const string &name)

C#

public static void Interface.EndPanel(string name);
public static void SplashKit.EndPanel(string name);

Python

def end_panel(name):

Pascal

procedure EndPanel(const name: String)

---

End Popup

Finishes the creation of a popup.

Parameters:

Name	Type	Description
name	String	The popup’s name - must match with Start Popup

Signatures:

C++

void end_popup(const string &name)

C#

public static void Interface.EndPopup(string name);
public static void SplashKit.EndPopup(string name);

Python

def end_popup(name):

Pascal

procedure EndPopup(const name: String)

---

End Treenode

Finishes the creation of a tree node.

Parameters:

Name	Type	Description
label	String	The node’s name - must match with Start Treenode

Signatures:

C++

void end_treenode(const string &label)

C#

public static void Interface.EndTreenode(string label);
public static void SplashKit.EndTreenode(string label);

Python

def end_treenode(label):

Pascal

procedure EndTreenode(const label: String)

---

Enter Column

Begins placing elements inside the current column. Must be paired with a call to Leave Column.

Signatures:

C++

void enter_column()

C#

public static void Interface.EnterColumn();
public static void SplashKit.EnterColumn();

Python

def enter_column():

Pascal

procedure EnterColumn()

---

Get Interface Label Width

Returns the width of element labels. Default is 60 pixels.

Return Type: Integer

Signatures:

C++

int get_interface_label_width()

C#

public static int Interface.GetInterfaceLabelWidth();
public static int SplashKit.GetInterfaceLabelWidth();

Python

def get_interface_label_width():

Pascal

function GetInterfaceLabelWidth(): Integer

---

Header

Creates a collapsable header with a label. Returns whether the header is expanded or not. Note: Unlike Start Panel and other similar functions, there is no need to ‘end’ this one. Example usage: c++ if (header("Section A")) { // elements inside header go here }

Parameters:

Name	Type	Description
label	String	The label to show in the header

Return Type: Boolean

Signatures:

C++

bool header(const string &label)

C#

public static bool Interface.Header(string label);
public static bool SplashKit.Header(string label);

Python

def header(label):

Pascal

function Header(const label: String): Boolean

---

Hsb Color Slider

Note

This function is overloaded. The following versions exist:

• Hsb Color Slider (clr: color, rect: rectangle)
• Hsb Color Slider (clr: color)
• Hsb Color Slider (label: string, clr: color)

Hsb Color Slider

Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, at a specific position on screen. Returns the updated color value of the slider.

Parameters:

Name	Type	Description
clr	Color	The current value of the color slider
rect	Rectangle	The rectangle to display the slider in.

Return Type: Color

Signatures:

C++

color hsb_color_slider(const color &clr, const rectangle &rect)

C#

public static Color Interface.HSBColorSlider(Color clr, Rectangle rect);
public static Color SplashKit.HSBColorSlider(Color clr, Rectangle rect);

Python

def hsb_color_slider_at_position(clr, rect):

Pascal

function HSBColorSlider(const clr: Color; const rect: Rectangle): Color

---

Hsb Color Slider

Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color. Returns the updated color value of the slider.

Parameters:

Name	Type	Description
clr	Color	The current value of the color slider

Return Type: Color

Signatures:

C++

color hsb_color_slider(const color &clr)

C#

public static Color Interface.HSBColorSlider(Color clr);
public static Color SplashKit.HSBColorSlider(Color clr);

Python

def hsb_color_slider(clr):

Pascal

function HSBColorSlider(const clr: Color): Color

---

Hsb Color Slider

Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, with a label. Returns the updated color value of the slider. Example usage: c++ my_color = hsb_color_slider("Player Color", my_color);

Parameters:

Name	Type	Description
label	String	The label to show in front of the slider
clr	Color	The current value of the color slider

Return Type: Color

Signatures:

C++

color hsb_color_slider(const string &label, const color &clr)

C#

public static Color Interface.HSBColorSlider(string label, Color clr);
public static Color SplashKit.HSBColorSlider(string label, Color clr);

Python

def hsb_color_slider_labeled(label, clr):

Pascal

function HSBColorSlider(const label: String; const clr: Color): Color

---

Interface Enabled

Returns if the interface is currently enabled or not.

Return Type: Boolean

Signatures:

C++

bool interface_enabled()

C#

public static bool Interface.InterfaceEnabled();
public static bool SplashKit.InterfaceEnabled();

Python

def interface_enabled():

Pascal

function InterfaceEnabled(): Boolean

---

Interface Style Panel

A utility function to show a ‘Style Panel’, which will allows you to experiment with different interface styles.

Parameters:

Name	Type	Description
initial_rectangle	Rectangle	The initial position/size the panel starts off in

Signatures:

C++

void interface_style_panel(const rectangle &initial_rectangle)

C#

public static void Interface.InterfaceStylePanel(Rectangle initialRectangle);
public static void SplashKit.InterfaceStylePanel(Rectangle initialRectangle);

Python

def interface_style_panel(initial_rectangle):

Pascal

procedure InterfaceStylePanel(const initialRectangle: Rectangle)

---

Label

Note

This function is overloaded. The following versions exist:

• Label (label: string)
• Label (label: string, rect: rectangle)

Label

Creates a label.

Parameters:

Name	Type	Description
label	String	The label to show

Signatures:

C++

void label(const string &label)

C#

public static void Interface.Label(string label);
public static void SplashKit.Label(string label);

Python

def label(label):

Pascal

procedure Label(const label: String)

---

Label

Creates a label at a specific position on screen.

Parameters:

Name	Type	Description
label	String	The label to show
rect	Rectangle	The rectangle to display the label in

Signatures:

C++

void label(const string &label, const rectangle &rect)

C#

public static void Interface.Label(string label, Rectangle rect);
public static void SplashKit.Label(string label, Rectangle rect);

Python

def label_at_position(label, rect):

Pascal

procedure Label(const label: String; const rect: Rectangle)

---

Last Element Changed

Returns if the last created element was changed at all (such as dragged, typed in, etc)

Return Type: Boolean

Signatures:

C++

bool last_element_changed()

C#

public static bool Interface.LastElementChanged();
public static bool SplashKit.LastElementChanged();

Python

def last_element_changed():

Pascal

function LastElementChanged(): Boolean

---

Last Element Confirmed

Returns if the last created element was ‘confirmed’ (such as clicking a button, or hitting enter in a text box)

Return Type: Boolean

Signatures:

C++

bool last_element_confirmed()

C#

public static bool Interface.LastElementConfirmed();
public static bool SplashKit.LastElementConfirmed();

Python

def last_element_confirmed():

Pascal

function LastElementConfirmed(): Boolean

---

Leave Column

Stops placing elements inside the current column and moves to the next one.

Signatures:

C++

void leave_column()

C#

public static void Interface.LeaveColumn();
public static void SplashKit.LeaveColumn();

Python

def leave_column():

Pascal

procedure LeaveColumn()

---

Number Box

Note

This function is overloaded. The following versions exist:

• Number Box (value: float, step: float, rect: rectangle)
• Number Box (value: float, step: float)
• Number Box (label: string, value: float, step: float)

Number Box

Creates a number entry box at a specific position on screen. Returns the updated value of the number box.

Parameters:

Name	Type	Description
value	Float	The current value of the number box
step	Float	The amount incremented when dragging on the box
rect	Rectangle	The rectangle to display the slider in

Return Type: Float

Signatures:

C++

float number_box(const float &value, float step, const rectangle &rect)

C#

public static float Interface.NumberBox(float value, float step, Rectangle rect);
public static float SplashKit.NumberBox(float value, float step, Rectangle rect);

Python

def number_box_at_position(value, step, rect):

Pascal

function NumberBox(const value: Single; step: Single; const rect: Rectangle): Single

---

Number Box

Creates a number entry box with a label. Returns the updated value of the number box.

Parameters:

Name	Type	Description
value	Float	The current value of the number box
step	Float	The amount incremented when dragging on the box

Return Type: Float

Signatures:

C++

float number_box(const float &value, float step)

C#

public static float Interface.NumberBox(float value, float step);
public static float SplashKit.NumberBox(float value, float step);

Python

def number_box(value, step):

Pascal

function NumberBox(const value: Single; step: Single): Single

---

Number Box

Creates a number entry box with a label. Returns the updated value of the number box. Example usage: c++ my_float = number_box("Percentage", my_float, 1);

Parameters:

Name	Type	Description
label	String	The label to show in front of the number box
value	Float	The current value of the number box
step	Float	The amount incremented when dragging on the box

Return Type: Float

Signatures:

C++

float number_box(const string &label, const float &value, float step)

C#

public static float Interface.NumberBox(string label, float value, float step);
public static float SplashKit.NumberBox(string label, float value, float step);

Python

def number_box_labeled(label, value, step):

Pascal

function NumberBox(const label: String; const value: Single; step: Single): Single

---

Open Popup

Makes the popup named name open/popup at the cursor’s position.

Parameters:

Name	Type	Description
name	String	The popup’s name. Must match with the same name used in Start Popup

Signatures:

C++

void open_popup(const string &name)

C#

public static void Interface.OpenPopup(string name);
public static void SplashKit.OpenPopup(string name);

Python

def open_popup(name):

Pascal

procedure OpenPopup(const name: String)

---

Paragraph

Note

This function is overloaded. The following versions exist:

• Paragraph (text: string)
• Paragraph (text: string, rect: rectangle)

Paragraph

Creates a paragraph of text that auto-wraps.

Parameters:

Name	Type	Description
text	String	The text to show

Signatures:

C++

void paragraph(const string &text)

C#

public static void Interface.Paragraph(string text);
public static void SplashKit.Paragraph(string text);

Python

def paragraph(text):

Pascal

procedure Paragraph(const text: String)

---

Paragraph

Creates a paragraph of text that auto-wraps at a specific position on screen.

Parameters:

Name	Type	Description
text	String	The text to show
rect	Rectangle	The rectangle to display the label in

Signatures:

C++

void paragraph(const string &text, const rectangle &rect)

C#

public static void Interface.Paragraph(string text, Rectangle rect);
public static void SplashKit.Paragraph(string text, Rectangle rect);

Python

def paragraph_at_position(text, rect):

Pascal

procedure Paragraph(const text: String; const rect: Rectangle)

---

Reset Layout

Resets to the default layout of a single column with default height.

Signatures:

C++

void reset_layout()

C#

public static void Interface.ResetLayout();
public static void SplashKit.ResetLayout();

Python

def reset_layout():

Pascal

procedure ResetLayout()

---

Set Interface Accent Color

Sets the color of accents in the interface, and the contrast of how strongly they appear when hovering/interacting.

Parameters:

Name	Type	Description
clr	Color	The color of accents
contrast	Float	The strength of how much the accents show (between 0 and 1)

Signatures:

C++

void set_interface_accent_color(color clr, float contrast)

C#

public static void Interface.SetInterfaceAccentColor(Color clr, float contrast);
public static void SplashKit.SetInterfaceAccentColor(Color clr, float contrast);

Python

def set_interface_accent_color(clr, contrast):

Pascal

procedure SetInterfaceAccentColor(clr: Color; contrast: Single)

---

Set Interface Border Color

Sets the interface’s border color.

Parameters:

Name	Type	Description
clr	Color	The color to set borders to

Signatures:

C++

void set_interface_border_color(color clr)

C#

public static void Interface.SetInterfaceBorderColor(Color clr);
public static void SplashKit.SetInterfaceBorderColor(Color clr);

Python

def set_interface_border_color(clr):

Pascal

procedure SetInterfaceBorderColor(clr: Color)

---

Set Interface Colors Auto

A convenience function to set the majority of the interface’s colors in one go. Some colors will be automatically chosen based on the parameters (such as text color).

Parameters:

Name	Type	Description
main_clr	Color	The main color of the interface - also decides if the interface is light or dark mode
accent_clr	Color	The color used to accent the interface - this will appear in highlighted areas
contrast	Float	The contrast between the frames of elements/containers and their internal elements
accent_contrast	Float	How strongly the accent color is used, for instance when highlighting elements
border_contrast	Float	Simply the opacity of the borders

Signatures:

C++

void set_interface_colors_auto(color main_clr, color accent_clr, float contrast, float accent_contrast, float border_contrast)

C#

public static void Interface.SetInterfaceColorsAuto(Color mainClr, Color accentClr, float contrast, float accentContrast, float borderContrast);
public static void SplashKit.SetInterfaceColorsAuto(Color mainClr, Color accentClr, float contrast, float accentContrast, float borderContrast);

Python

def set_interface_colors_auto(main_clr, accent_clr, contrast, accent_contrast, border_contrast):

Pascal

procedure SetInterfaceColorsAuto(mainClr: Color; accentClr: Color; contrast: Single; accentContrast: Single; borderContrast: Single)

---

Set Interface Element Color

Sets the main color of elements in the interface, and the contrast between their frame and internal pieces.

Parameters:

Name	Type	Description
clr	Color	The color of elements
contrast	Float	The contrast between the frame of elements and their internal pieces (between 0 and 1)

Signatures:

C++

void set_interface_element_color(color clr, float contrast)

C#

public static void Interface.SetInterfaceElementColor(Color clr, float contrast);
public static void SplashKit.SetInterfaceElementColor(Color clr, float contrast);

Python

def set_interface_element_color(clr, contrast):

Pascal

procedure SetInterfaceElementColor(clr: Color; contrast: Single)

---

Set Interface Element Shadows

Sets the style of element’s shadows. Use a fully transparent color to disable them.

Parameters:

Name	Type	Description
radius	Integer	The radius of the shadow’s blur
clr	Color	The color of the shadows (commonly black, but can do coloured and semi-transparent too)
offset	Point 2d	The offset in x/y coordinates of the shadows from their casting elements

Signatures:

C++

void set_interface_element_shadows(int radius, color clr, point_2d offset)

C#

public static void Interface.SetInterfaceElementShadows(int radius, Color clr, Point2D offset);
public static void SplashKit.SetInterfaceElementShadows(int radius, Color clr, Point2D offset);

Python

def set_interface_element_shadows(radius, clr, offset):

Pascal

procedure SetInterfaceElementShadows(radius: Integer; clr: Color; offset: Point2D)

---

Set Interface Font

Note

This function is overloaded. The following versions exist:

• Set Interface Font (fnt: string)
• Set Interface Font (fnt: font)

Set Interface Font

Sets the interface’s font.

Parameters:

Name	Type	Description
fnt	String	The name of the font to be used

Signatures:

C++

void set_interface_font(const string &fnt)

C#

public static void Interface.SetInterfaceFont(string fnt);
public static void SplashKit.SetInterfaceFont(string fnt);

Python

def set_interface_font_font_as_string(fnt):

Pascal

procedure SetInterfaceFont(const fnt: String)

---

Set Interface Font

Sets the interface’s font.

Parameters:

Name	Type	Description
fnt	Font	The font to be used

Signatures:

C++

void set_interface_font(font fnt)

C#

public static void Interface.SetInterfaceFont(Font fnt);
public static void SplashKit.SetInterfaceFont(Font fnt);

Python

def set_interface_font(fnt):

Pascal

procedure SetInterfaceFont(fnt: Font)

---

Set Interface Font Size

Sets the interface’s font size.

Parameters:

Name	Type	Description
size	Integer	The font size to be used

Signatures:

C++

void set_interface_font_size(int size)

C#

public static void Interface.SetInterfaceFontSize(int size);
public static void SplashKit.SetInterfaceFontSize(int size);

Python

def set_interface_font_size(size):

Pascal

procedure SetInterfaceFontSize(size: Integer)

---

Set Interface Label Width

Sets the width of element labels. This is the maximum width in pixels that a label can span in front of an element. Default is 60 pixels.

Parameters:

Name	Type	Description
width	Integer	The width of labels

Signatures:

C++

void set_interface_label_width(int width)

C#

public static void Interface.SetInterfaceLabelWidth(int width);
public static void SplashKit.SetInterfaceLabelWidth(int width);

Python

def set_interface_label_width(width):

Pascal

procedure SetInterfaceLabelWidth(width: Integer)

---

Set Interface Panel Shadows

Sets the style of panel’s shadows. Use a fully transparent color to disable them.

Parameters:

Name	Type	Description
radius	Integer	The radius of the shadow’s blur
clr	Color	The color of the shadows (commonly black, but can do coloured and semi-transparent too)
offset	Point 2d	The offset in x/y coordinates of the shadows from their casting elements

Signatures:

C++

void set_interface_panel_shadows(int radius, color clr, point_2d offset)

C#

public static void Interface.SetInterfacePanelShadows(int radius, Color clr, Point2D offset);
public static void SplashKit.SetInterfacePanelShadows(int radius, Color clr, Point2D offset);

Python

def set_interface_panel_shadows(radius, clr, offset):

Pascal

procedure SetInterfacePanelShadows(radius: Integer; clr: Color; offset: Point2D)

---

Set Interface Root Text Color

Sets color of text drawn directly onto the main window

Parameters:

Name	Type	Description
clr	Color	The color to set text drawn on the main window to

Signatures:

C++

void set_interface_root_text_color(color clr)

C#

public static void Interface.SetInterfaceRootTextColor(Color clr);
public static void SplashKit.SetInterfaceRootTextColor(Color clr);

Python

def set_interface_root_text_color(clr):

Pascal

procedure SetInterfaceRootTextColor(clr: Color)

---

Set Interface Shadows

Sets the style of all interface shadows. Use a fully transparent color to disable them.

Parameters:

Name	Type	Description
radius	Integer	The radius of the shadow’s blur
clr	Color	The color of the shadows (commonly black, but can do coloured and semi-transparent too)
offset	Point 2d	The offset in x/y coordinates of the shadows from their casting elements

Signatures:

C++

void set_interface_shadows(int radius, color clr, point_2d offset)

C#

public static void Interface.SetInterfaceShadows(int radius, Color clr, Point2D offset);
public static void SplashKit.SetInterfaceShadows(int radius, Color clr, Point2D offset);

Python

def set_interface_shadows(radius, clr, offset):

Pascal

procedure SetInterfaceShadows(radius: Integer; clr: Color; offset: Point2D)

---

Set Interface Spacing

Sets the spacing within the interface.

Parameters:

Name	Type	Description
spacing	Integer	The distance between elements
padding	Integer	The padding within elements

Signatures:

C++

void set_interface_spacing(int spacing, int padding)

C#

public static void Interface.SetInterfaceSpacing(int spacing, int padding);
public static void SplashKit.SetInterfaceSpacing(int spacing, int padding);

Python

def set_interface_spacing(spacing, padding):

Pascal

procedure SetInterfaceSpacing(spacing: Integer; padding: Integer)

---

Set Interface Style

Note

This function is overloaded. The following versions exist:

• Set Interface Style (style: interface_style)
• Set Interface Style (style: interface_style, clr: color)

Set Interface Style

Sets the interface style to one of the presets in the interface_style enum.

Parameters:

Name	Type	Description
style	Interface Style	The preset style to use

Signatures:

C++

void set_interface_style(interface_style style)

C#

public static void Interface.SetInterfaceStyle(InterfaceStyle style);
public static void SplashKit.SetInterfaceStyle(InterfaceStyle style);

Python

def set_interface_style(style):

Pascal

procedure SetInterfaceStyle(style: InterfaceStyle)

---

Set Interface Style

Sets the interface style to one of the presets in the interface_style enum. Also accepts a color used to customize the interface.

Parameters:

Name	Type	Description
style	Interface Style	The preset style to use
clr	Color	The color to style the interface after

Signatures:

C++

void set_interface_style(interface_style style, color clr)

C#

public static void Interface.SetInterfaceStyle(InterfaceStyle style, Color clr);
public static void SplashKit.SetInterfaceStyle(InterfaceStyle style, Color clr);

Python

def set_interface_style_with_color(style, clr):

Pascal

procedure SetInterfaceStyle(style: InterfaceStyle; clr: Color)

---

Set Interface Text Color

Sets the interface’s text color.

Parameters:

Name	Type	Description
clr	Color	The color to set text to

Signatures:

C++

void set_interface_text_color(color clr)

C#

public static void Interface.SetInterfaceTextColor(Color clr);
public static void SplashKit.SetInterfaceTextColor(Color clr);

Python

def set_interface_text_color(clr):

Pascal

procedure SetInterfaceTextColor(clr: Color)

---

Set Layout Height

Sets the height of each row in the interface in pixels. 0 resets to default.

Parameters:

Name	Type	Description
height	Integer	Height of rows in pixels

Signatures:

C++

void set_layout_height(int height)

C#

public static void Interface.SetLayoutHeight(int height);
public static void SplashKit.SetLayoutHeight(int height);

Python

def set_layout_height(height):

Pascal

procedure SetLayoutHeight(height: Integer)

---

Single Line Layout

Starts layouting all elements onto a single row. Reset with reset_layout().

Signatures:

C++

void single_line_layout()

C#

public static void Interface.SingleLineLayout();
public static void SplashKit.SingleLineLayout();

Python

def single_line_layout():

Pascal

procedure SingleLineLayout()

---

Slider

Note

This function is overloaded. The following versions exist:

• Slider (value: float, min_value: float, max_value: float, rect: rectangle)
• Slider (value: float, min_value: float, max_value: float)
• Slider (label: string, value: float, min_value: float, max_value: float)

Slider

Creates a slider at a specific position on screen. Returns the updated value of the slider.

Parameters:

Name	Type	Description
value	Float	The current value of the slider
min_value	Float	The minimum value of the slider
max_value	Float	The maximum value of the slider
rect	Rectangle	The rectangle to display the slider in

Return Type: Float

Signatures:

C++

float slider(const float &value, float min_value, float max_value, const rectangle &rect)

C#

public static float Interface.Slider(float value, float minValue, float maxValue, Rectangle rect);
public static float SplashKit.Slider(float value, float minValue, float maxValue, Rectangle rect);

Python

def slider_at_position(value, min_value, max_value, rect):

Pascal

function Slider(const value: Single; minValue: Single; maxValue: Single; const rect: Rectangle): Single

---

Slider

Creates a slider without a label. Returns the updated value of the slider.

Parameters:

Name	Type	Description
value	Float	The current value of the slider
min_value	Float	The minimum value of the slider
max_value	Float	The maximum value of the slider

Return Type: Float

Signatures:

C++

float slider(const float &value, float min_value, float max_value)

C#

public static float Interface.Slider(float value, float minValue, float maxValue);
public static float SplashKit.Slider(float value, float minValue, float maxValue);

Python

def slider(value, min_value, max_value):

Pascal

function Slider(const value: Single; minValue: Single; maxValue: Single): Single

---

Slider

Creates a slider with a label. Returns the updated value of the slider. Example usage: c++ my_float = slider("Percentage", my_float, 0, 100);

Parameters:

Name	Type	Description
label	String	The label to show in front of the slider
value	Float	The current value of the slider
min_value	Float	The minimum value of the slider
max_value	Float	The maximum value of the slider

Return Type: Float

Signatures:

C++

float slider(const string &label, const float &value, float min_value, float max_value)

C#

public static float Interface.Slider(string label, float value, float minValue, float maxValue);
public static float SplashKit.Slider(string label, float value, float minValue, float maxValue);

Python

def slider_labeled(label, value, min_value, max_value):

Pascal

function Slider(const label: String; const value: Single; minValue: Single; maxValue: Single): Single

---

Split Into Columns

Note

This function is overloaded. The following versions exist:

• Split Into Columns (count: int)
• Split Into Columns (count: int, last_width: int)

Split Into Columns

Adds count columns to the current layout, with equal widths

Parameters:

Name	Type	Description
count	Integer	Number of columns to add

Signatures:

C++

void split_into_columns(int count)

C#

public static void Interface.SplitIntoColumns(int count);
public static void SplashKit.SplitIntoColumns(int count);

Python

def split_into_columns(count):

Pascal

procedure SplitIntoColumns(count: Integer)

---

Split Into Columns

Adds count columns to the current layout, with equal widths. Has extra parameter last_width, which lets you specify a specific width (in pixels) for the last column.

Parameters:

Name	Type	Description
count	Integer	Number of columns to add
last_width	Integer	The width of the last column in pixels

Signatures:

C++

void split_into_columns(int count, int last_width)

C#

public static void Interface.SplitIntoColumns(int count, int lastWidth);
public static void SplashKit.SplitIntoColumns(int count, int lastWidth);

Python

def split_into_columns_with_last_width(count, last_width):

Pascal

procedure SplitIntoColumns(count: Integer; lastWidth: Integer)

---

Split Into Columns Relative

Adds count columns to the current layout, with equal widths. Has extra parameter last_width, which lets you specify a specific width (relative to the width of the container, between 0 and 1) for the last column.

Parameters:

Name	Type	Description
count	Integer	Number of columns to add
last_width	Double	The width of the last column as percentage of the container’s width (between 0 and 1)

Signatures:

C++

void split_into_columns_relative(int count, double last_width)

C#

public static void Interface.SplitIntoColumnsRelative(int count, double lastWidth);
public static void SplashKit.SplitIntoColumnsRelative(int count, double lastWidth);

Python

def split_into_columns_relative_with_last_width(count, last_width):

Pascal

procedure SplitIntoColumnsRelative(count: Integer; lastWidth: Double)

---

Start Custom Layout

Clears the default layout so that a custom layout can be made.

Signatures:

C++

void start_custom_layout()

C#

public static void Interface.StartCustomLayout();
public static void SplashKit.StartCustomLayout();

Python

def start_custom_layout():

Pascal

procedure StartCustomLayout()

---

Start Inset

Note

This function is overloaded. The following versions exist:

• Start Inset (name: string, rect: rectangle)
• Start Inset (name: string, height: int)

Start Inset

Starts the creation of an inset area inside an arbitrary rectangle. The function must be accompanied by a call to End Inset with the same name.

Parameters:

Name	Type	Description
name	String	The name of the area
rect	Rectangle	The rectangle for the inset

Signatures:

C++

void start_inset(const string &name, const rectangle &rect)

C#

public static void Interface.StartInset(string name, Rectangle rect);
public static void SplashKit.StartInset(string name, Rectangle rect);

Python

def start_inset_at_position(name, rect):

Pascal

procedure StartInset(const name: String; const rect: Rectangle)

---

Start Inset

Starts the creation of an inset area inside a panel/popup. Use as follows: c++ start_inset("Inset area", 60); // elements inside area goes here end_inset("Inset area"); The function must be accompanied by a call to End Inset with the same name.

Parameters:

Name	Type	Description
name	String	The name of the area
height	Integer	Height of the inset area in pixels. -1 fills entire space. Use negative heights to fill up to height away from the bottom

Signatures:

C++

void start_inset(const string &name, int height)

C#

public static void Interface.StartInset(string name, int height);
public static void SplashKit.StartInset(string name, int height);

Python

def start_inset(name, height):

Pascal

procedure StartInset(const name: String; height: Integer)

---

Start Panel

Starts the creation of a draggable panel with a title bar. Returns whether the panel is visible or not. Use as follows: c++ if (start_panel("My panel", rectangle_from(0,0,100,100))) { // Rest of interface goes here end_panel("My panel"); } After calling this, you can then call functions to add elements such as buttons and text boxes inside the panel. The function must be accompanied by a call to End Panel, that is only called if the panel is visible, and is passed the same name.

Parameters:

Name	Type	Description
name	String	The name shown in the panel’s titlebar
initial_rectangle	Rectangle	The initial position/size the panel starts off in

Return Type: Boolean

Signatures:

C++

bool start_panel(const string &name, rectangle initial_rectangle)

C#

public static bool Interface.StartPanel(string name, Rectangle initialRectangle);
public static bool SplashKit.StartPanel(string name, Rectangle initialRectangle);

Python

def start_panel(name, initial_rectangle):

Pascal

function StartPanel(const name: String; initialRectangle: Rectangle): Boolean

---

Start Popup

Starts the creation of a popup. Returns whether the popup is visible or not. Usage is the same as Start Panel, other than the ‘starting rectangle’ will be automatically calculated. The function must be accompanied by a call to End Popup with the same name.

Parameters:

Name	Type	Description
name	String	The name of the popup

Return Type: Boolean

Signatures:

C++

bool start_popup(const string &name)

C#

public static bool Interface.StartPopup(string name);
public static bool SplashKit.StartPopup(string name);

Python

def start_popup(name):

Pascal

function StartPopup(const name: String): Boolean

---

Start Treenode

Starts the creation of a tree node (such as those in a file tree view). Returns whether the tree node is expanded or not. Usage is the same as Start Panel. The function must be accompanied by a call to End Treenode with the same name.

Parameters:

Name	Type	Description
label	String	The name of the node

Return Type: Boolean

Signatures:

C++

bool start_treenode(const string &label)

C#

public static bool Interface.StartTreenode(string label);
public static bool SplashKit.StartTreenode(string label);

Python

def start_treenode(label):

Pascal

function StartTreenode(const label: String): Boolean

---

Text Box

Note

This function is overloaded. The following versions exist:

• Text Box (value: string)
• Text Box (value: string, rect: rectangle)
• Text Box (label: string, value: string)

Text Box

Creates a text entry box with a label. Returns the updated value of the text box.

Parameters:

Name	Type	Description
value	String	The current value of the text box

Return Type: String

Signatures:

C++

string text_box(const string &value)

C#

public static string Interface.TextBox(string value);
public static string SplashKit.TextBox(string value);

Python

def text_box(value):

Pascal

function TextBox(const value: String): String

---

Text Box

Creates a text entry box at a specific position on screen. Returns the updated value of the text box. Example usage: c++ my_string = text_box("Name", my_string);

Parameters:

Name	Type	Description
value	String	The current value of the text box
rect	Rectangle	The rectangle to display the button in

Return Type: String

Signatures:

C++

string text_box(const string &value, const rectangle &rect)

C#

public static string Interface.TextBox(string value, Rectangle rect);
public static string SplashKit.TextBox(string value, Rectangle rect);

Python

def text_box_at_position(value, rect):

Pascal

function TextBox(const value: String; const rect: Rectangle): String

---

Text Box

Creates a text entry box with a label. Returns the updated value of the text box. Example usage: c++ my_string = text_box("Name", my_string);

Parameters:

Name	Type	Description
label	String	The label to show in front of the text box
value	String	The current value of the text box

Return Type: String

Signatures:

C++

string text_box(const string &label, const string &value)

C#

public static string Interface.TextBox(string label, string value);
public static string SplashKit.TextBox(string label, string value);

Python

def text_box_labeled(label, value):

Pascal

function TextBox(const label: String; const value: String): String

---