Utilities

Utilities

SplashKit provides some basic data manipulation functions to help make it easy to get some basic tasks performed.SplashKit random provides a simple implementation of random.SplashKit provides miscellaneous utilities for unclassified functionality.

Functions

Base64 Decode

Converts the provided Base64 encoded string back to its original form. For example, “TWFu” will be converted to “Man”.

Parameters:

Name	Type	Description
input	String	Base64 encoded string to decode

Return Type: String

Signatures:

C++

string base64_decode(const string &input)

C#

public static string Utilities.Base64Decode(string input);
public static string SplashKit.Base64Decode(string input);

Python

def base64_decode(input):

Pascal

function Base64Decode(const input: String): String

---

Base64 Encode

Converts the provided string into its Base64 encoded representation. For example, “Man” will be converted to “TWFu”.

Parameters:

Name	Type	Description
input	String	String to encode

Return Type: String

Signatures:

C++

string base64_encode(const string &input)

C#

public static string Utilities.Base64Encode(string input);
public static string SplashKit.Base64Encode(string input);

Python

def base64_encode(input):

Pascal

function Base64Encode(const input: String): String

---

Bin To Dec

Converts the provided binary string into an unsigned integer. For example, “1010” will be converted to 10.

Parameters:

Name	Type	Description
bin	String	Binary string to convert

Return Type: Unsigned Integer

Signatures:

C++

unsigned int bin_to_dec(const string &bin)

C#

public static uint Utilities.BinToDec(string bin);
public static uint SplashKit.BinToDec(string bin);

Python

def bin_to_dec(bin):

Pascal

function BinToDec(const bin: String): Cardinal

---

Bin To Hex

Converts the provided binary string into a hexadecimal string representation. For example, “1010” will be converted to “A”.

Parameters:

Name	Type	Description
bin_str	String	Binary string to convert

Return Type: String

Signatures:

C++

string bin_to_hex(const string &bin_str)

C#

public static string Utilities.BinToHex(string binStr);
public static string SplashKit.BinToHex(string binStr);

Python

def bin_to_hex(bin_str):

Pascal

function BinToHex(const binStr: String): String

---

Bin To Oct

Converts the provided binary string into its octal string representation. For example, “1010” will be converted to “12”.

Parameters:

Name	Type	Description
bin_str	String	Binary string to convert

Return Type: String

Signatures:

C++

string bin_to_oct(const string &bin_str)

C#

public static string Utilities.BinToOct(string binStr);
public static string SplashKit.BinToOct(string binStr);

Python

def bin_to_oct(bin_str):

Pascal

function BinToOct(const binStr: String): String

---

Calculate Square Root

Calculates the square root of the provided number using the Newton-Raphson method.

Parameters:

Name	Type	Description
number	Integer	Number to calculate the square root of

Return Type: Double

Signatures:

C++

double calculate_square_root(int number)

C#

public static double Utilities.CalculateSquareRoot(int number);
public static double SplashKit.CalculateSquareRoot(int number);

Python

def calculate_square_root(number):

Pascal

function CalculateSquareRoot(number: Integer): Double

---

Contains

Returns true if the string contains the substring.

Parameters:

Name	Type	Description
text	String	The text to search
subtext	String	The substring to search for

Return Type: Boolean

Signatures:

C++

bool contains(const string &text, const string &subtext)

C#

public static bool Utilities.Contains(string text, string subtext);
public static bool SplashKit.Contains(string text, string subtext);

Python

def contains(text, subtext):

Pascal

function Contains(const text: String; const subtext: String): Boolean

---

Convert To Double

Convert the passed in string into a double. This can fail in an error if the value is not a number, consider using Is Number to check before converting a string.

Parameters:

Name	Type	Description
text	String	The text to convert.

Return Type: Double

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

double convert_to_double(const string &text)

C#

public static double Utilities.ConvertToDouble(string text);
public static double SplashKit.ConvertToDouble(string text);

Python

def convert_to_double(text):

Pascal

function ConvertToDouble(const text: String): Double

---

Convert To Integer

Convert the passed in string into an integer. This can fail in an error if the value is not an integer, consider using Is Integer to check before converting a string.

Parameters:

Name	Type	Description
text	String	The text to convert.

Return Type: Integer

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

int convert_to_integer(const string &text)

C#

public static int Utilities.ConvertToInteger(string text);
public static int SplashKit.ConvertToInteger(string text);

Python

def convert_to_integer(text):

Pascal

function ConvertToInteger(const text: String): Integer

---

Dec To Bin

Converts the provided unsigned integer into a binary string. For example, 10 will be converted to “1010”.

Parameters:

Name	Type	Description
dec	unsigned int	Decimal (unsigned integer) to convert

Return Type: String

Signatures:

C++

string dec_to_bin(unsigned int dec)

C#

public static string Utilities.DecToBin(uint dec);
public static string SplashKit.DecToBin(uint dec);

Python

def dec_to_bin(dec):

Pascal

function DecToBin(dec: Cardinal): String

---

Dec To Oct

Converts the provided decimal value into its octal string representation. For example, 64 will be converted to “100”.

Parameters:

Name	Type	Description
decimal_value	unsigned int	Decimal (unsigned integer) to convert

Return Type: String

Signatures:

C++

string dec_to_oct(unsigned int decimal_value)

C#

public static string Utilities.DecToOct(uint decimalValue);
public static string SplashKit.DecToOct(uint decimalValue);

Python

def dec_to_oct(decimal_value):

Pascal

function DecToOct(decimalValue: Cardinal): String

---

Greatest Common Divisor

The greatest common divisor (GCD) of two numbers is the largest positive integer that divides both numbers without a remainder.

Parameters:

Name	Type	Description
number1	Integer	First number
number2	Integer	Second number

Return Type: Integer

Signatures:

C++

int greatest_common_divisor(int number1, int number2)

C#

public static int Utilities.GreatestCommonDivisor(int number1, int number2);
public static int SplashKit.GreatestCommonDivisor(int number1, int number2);

Python

def greatest_common_divisor(number1, number2):

Pascal

function GreatestCommonDivisor(number1: Integer; number2: Integer): Integer

---

Hex To Bin

Converts the provided hexadecimal string into its binary string representation. For example, “A” will be converted to “1010”.

Parameters:

Name	Type	Description
hex_str	String	Hexadecimal string to convert

Return Type: String

Signatures:

C++

string hex_to_bin(const string &hex_str)

C#

public static string Utilities.HexToBin(string hexStr);
public static string SplashKit.HexToBin(string hexStr);

Python

def hex_to_bin(hex_str):

Pascal

function HexToBin(const hexStr: String): String

---

Hex To Oct

Converts the provided hexadecimal string into its octal string representation. For example, “A” will be converted to “12”.

Parameters:

Name	Type	Description
hex_str	String	Hexadecimal string to convert

Return Type: String

Signatures:

C++

string hex_to_oct(const string &hex_str)

C#

public static string Utilities.HexToOct(string hexStr);
public static string SplashKit.HexToOct(string hexStr);

Python

def hex_to_oct(hex_str):

Pascal

function HexToOct(const hexStr: String): String

---

Index Of

Returns the index of the first occurrence of the substring in the text.

Parameters:

Name	Type	Description
text	String	The text to search
subtext	String	The substring to search for

Return Type: Integer

Signatures:

C++

int index_of(const string &text, const string &subtext)

C#

public static int Utilities.IndexOf(string text, string subtext);
public static int SplashKit.IndexOf(string text, string subtext);

Python

def index_of(text, subtext):

Pascal

function IndexOf(const text: String; const subtext: String): Integer

---

Is Binary

A binary string is a string that contains only ‘0’ and ‘1’ characters.

Parameters:

Name	Type	Description
bin_str	String	Binary string to check

Return Type: Boolean

Signatures:

C++

bool is_binary(const string &bin_str)

C#

public static bool Utilities.IsBinary(string binStr);
public static bool SplashKit.IsBinary(string binStr);

Python

def is_binary(bin_str):

Pascal

function IsBinary(const binStr: String): Boolean

---

Is Double

Checks if a string contains a number.

Parameters:

Name	Type	Description
text	String	The text to check.

Return Type: Boolean

Signatures:

C++

bool is_double(const string &text)

C#

public static bool Utilities.IsDouble(string text);
public static bool SplashKit.IsDouble(string text);

Python

def is_double(text):

Pascal

function IsDouble(const text: String): Boolean

---

Is Hex

A hexadecimal string is a string that contains only characters from ‘0’ to ‘9’ and ‘A’ to ‘F’ (or ‘a’ to ‘f’).

Parameters:

Name	Type	Description
hex_str	String	Hexadecimal string to check

Return Type: Boolean

Signatures:

C++

bool is_hex(const string &hex_str)

C#

public static bool Utilities.IsHex(string hexStr);
public static bool SplashKit.IsHex(string hexStr);

Python

def is_hex(hex_str):

Pascal

function IsHex(const hexStr: String): Boolean

---

Is Integer

Checks if a string contains an integer value.

Parameters:

Name	Type	Description
text	String	The text to check.

Return Type: Boolean

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

bool is_integer(const string &text)

C#

public static bool Utilities.IsInteger(string text);
public static bool SplashKit.IsInteger(string text);

Python

def is_integer(text):

Pascal

function IsInteger(const text: String): Boolean

---

Is Number

Checks if a string contains a number.

Parameters:

Name	Type	Description
text	String	The text to check.

Return Type: Boolean

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

bool is_number(const string &text)

C#

public static bool Utilities.IsNumber(string text);
public static bool SplashKit.IsNumber(string text);

Python

def is_number(text):

Pascal

function IsNumber(const text: String): Boolean

---

Is Octal

An octal string is a string that contains only characters from ‘0’ to ‘7’.

Parameters:

Name	Type	Description
octal_str	String	Octal string to check

Return Type: Boolean

Signatures:

C++

bool is_octal(const string &octal_str)

C#

public static bool Utilities.IsOctal(string octalStr);
public static bool SplashKit.IsOctal(string octalStr);

Python

def is_octal(octal_str):

Pascal

function IsOctal(const octalStr: String): Boolean

---

Is Prime Number

A prime number is a number greater than 1 that has no positive divisors other than 1 and itself.

Parameters:

Name	Type	Description
number	Integer	Number to check

Return Type: Boolean

Signatures:

C++

bool is_prime_number(int number)

C#

public static bool Utilities.IsPrimeNumber(int number);
public static bool SplashKit.IsPrimeNumber(int number);

Python

def is_prime_number(number):

Pascal

function IsPrimeNumber(number: Integer): Boolean

---

Least Common Multiple

The least common multiple (LCM) of two numbers is the smallest positive integer that is divisible by both numbers.

Parameters:

Name	Type	Description
number1	Integer	First number
number2	Integer	Second number

Return Type: Integer

Signatures:

C++

int least_common_multiple(int number1, int number2)

C#

public static int Utilities.LeastCommonMultiple(int number1, int number2);
public static int SplashKit.LeastCommonMultiple(int number1, int number2);

Python

def least_common_multiple(number1, number2):

Pascal

function LeastCommonMultiple(number1: Integer; number2: Integer): Integer

---

Length Of

Returns the length of a string in characters.

Parameters:

Name	Type	Description
text	String	The text to get the length of

Return Type: Integer

Usage:

See Example Code

Signatures:

C++

int length_of(const string &text)

C#

public static int Utilities.LengthOf(string text);
public static int SplashKit.LengthOf(string text);

Python

def length_of(text):

Pascal

function LengthOf(const text: String): Integer

---

Oct To Bin

Converts the provided octal string into its binary string representation. For example, “12” will be converted to “1010”.

Parameters:

Name	Type	Description
octal_str	String	Octal string to convert

Return Type: String

Signatures:

C++

string oct_to_bin(const string &octal_str)

C#

public static string Utilities.OctToBin(string octalStr);
public static string SplashKit.OctToBin(string octalStr);

Python

def oct_to_bin(octal_str):

Pascal

function OctToBin(const octalStr: String): String

---

Oct To Dec

Converts the provided octal string into its decimal representation. For example, “100” will be converted to 64.

Parameters:

Name	Type	Description
octal_string	String	Octal string to convert

Return Type: Unsigned Integer

Signatures:

C++

unsigned int oct_to_dec(const string &octal_string)

C#

public static uint Utilities.OctToDec(string octalString);
public static uint SplashKit.OctToDec(string octalString);

Python

def oct_to_dec(octal_string):

Pascal

function OctToDec(const octalString: String): Cardinal

---

Oct To Hex

Converts the provided octal string into its hexadecimal string representation. For example, “12” will be converted to “A”.

Parameters:

Name	Type	Description
oct_str	String	Octal string to convert

Return Type: String

Signatures:

C++

string oct_to_hex(const string &oct_str)

C#

public static string Utilities.OctToHex(string octStr);
public static string SplashKit.OctToHex(string octStr);

Python

def oct_to_hex(oct_str):

Pascal

function OctToHex(const octStr: String): String

---

Replace All

Replace all occurrences of a substring in a string with another string.

Parameters:

Name	Type	Description
text	String	The text to search
substr	String	The substring to find and replace
newText	String	The string to replace the substring with

Return Type: String

Signatures:

C++

string replace_all(const string &text, const string &substr, const string &newText)

C#

public static string Utilities.ReplaceAll(string text, string substr, string newtext);
public static string SplashKit.ReplaceAll(string text, string substr, string newtext);

Python

def replace_all(text, substr, newText):

Pascal

function ReplaceAll(const text: String; const substr: String; const newtext: String): String

---

Split

Split a string into an array of strings based on a delimiter.

Parameters:

Name	Type	Description
text	String	The text to split
delimiter	Char	The character to split the text on

Return Type: Vector

Signatures:

C++

vector<string> split(const string &text, char delimiter)

C#

public static List<string> Utilities.Split(string text, char delimiter);
public static List<string> SplashKit.Split(string text, char delimiter);

Python

def split(text, delimiter):

Pascal

function Split(const text: String; delimiter: Char): ArrayOfString

---

To Lowercase

Return a lowercase version of the passed in string.

Parameters:

Name	Type	Description
text	String	The text to convert.

Return Type: String

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

string to_lowercase(const string &text)

C#

public static string Utilities.ToLowercase(string text);
public static string SplashKit.ToLowercase(string text);

Python

def to_lowercase(text):

Pascal

function ToLowercase(const text: String): String

---

To Uppercase

Return a UPPERCASE version of the passed in string.

Parameters:

Name	Type	Description
text	String	The text to convert.

Return Type: String

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

string to_uppercase(const string &text)

C#

public static string Utilities.ToUppercase(string text);
public static string SplashKit.ToUppercase(string text);

Python

def to_uppercase(text):

Pascal

function ToUppercase(const text: String): String

---

Trim

Return a new string that removes the spaces from the start and end of the input string.

Parameters:

Name	Type	Description
text	String	The string to trim.

Return Type: String

Usage:

See Implemenations in Guides

• Useful Utilities

Signatures:

C++

string trim(const string &text)

C#

public static string Utilities.Trim(string text);
public static string SplashKit.Trim(string text);

Python

def trim(text):

Pascal

function Trim(const text: String): String

---

Rnd

Note

This function is overloaded. The following versions exist:

• Rnd (min: int, max: int)
• Rnd ()
• Rnd (ubound: int)

Rnd

Generates a random number between ‘min’ and max, including ‘min’ and ‘max’.

Parameters:

Name	Type	Description
min	Integer	the Integer representing of minimum bound.
max	Integer	the Integer representing of maximum bound.

Return Type: Integer

Signatures:

C++

int rnd(int min, int max)

C#

public static int Random.Rnd(int min, int max);
public static int SplashKit.Rnd(int min, int max);

Python

def rnd_range(min, max):

Pascal

function Rnd(min: Integer; max: Integer): Integer

---

Rnd

Generates a random number between 0 and 1

Return Type: Float

Signatures:

C++

float rnd()

C#

public static float Random.Rnd();
public static float SplashKit.Rnd();

Python

def rnd():

Pascal

function Rnd(): Single

---

Rnd

Generates a random number between 0 and ubound.

Parameters:

Name	Type	Description
ubound	Integer	the Integer representing the upper bound.

Return Type: Integer

Signatures:

C++

int rnd(int ubound)

C#

public static int Random.Rnd(int ubound);
public static int SplashKit.Rnd(int ubound);

Python

def rnd_int(ubound):

Pascal

function Rnd(ubound: Integer): Integer

---

Current Ticks

Gets the number of milliseconds that have passed since the program was started.

Return Type: Unsigned Integer

Signatures:

C++

unsigned int current_ticks()

C#

public static uint Utilities.CurrentTicks();
public static uint SplashKit.CurrentTicks();

Python

def current_ticks():

Pascal

function CurrentTicks(): Cardinal

---

Delay

Puts the program to sleep for a specified number of milliseconds. If this is larger than 1 second, SplashKit will check to see if the user tries to quit during the delay. If the user does quit, the delay function returns without waiting.

Parameters:

Name	Type	Description
milliseconds	Integer	The number of milliseconds to wait

Usage:

See Implemenations in Guides

• Drawing using Procedures
• Get Started with SplashKit GPIO
• Using PWM to control LED brightness

Signatures:

C++

void delay(int milliseconds)

C#

public static void Utilities.Delay(int milliseconds);
public static void SplashKit.Delay(int milliseconds);

Python

def delay(milliseconds):

Pascal

procedure Delay(milliseconds: Integer)

---

Display Dialog

Display a dialog to the screen with a message for the user.

Parameters:

Name	Type	Description
title	String	The title of the dialog window.
msg	String	The message for the dialog window.
output_font	Font	The font for the dialog text
font_size	Integer	The size of the font for the dialog text

Signatures:

C++

void display_dialog(const string &title, const string &msg, font output_font, int font_size)

C#

public static void Utilities.DisplayDialog(string title, string msg, Font outputFont, int fontSize);
public static void SplashKit.DisplayDialog(string title, string msg, Font outputFont, int fontSize);

Python

def display_dialog(title, msg, output_font, font_size):

Pascal

procedure DisplayDialog(const title: String; const msg: String; outputFont: Font; fontSize: Integer)

---

File As String

Return a SplashKit resource of Resource Kind with name filename as a string.

Parameters:

Name	Type	Description
filename	String	The filename of the resource.
kind	Resource Kind	The kind of resource.

Return Type: String

Signatures:

C++

string file_as_string(string filename, resource_kind kind)

C#

public static string Utilities.FileAsString(string filename, ResourceKind kind);
public static string SplashKit.FileAsString(string filename, ResourceKind kind);

Python

def file_as_string(filename, kind):

Pascal

function FileAsString(filename: String; kind: ResourceKind): String

---