Graphics

Functions

Draw Circle

Draw a circle on the current window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
c	`Circle`	The circle being drawn

Signatures:

void draw_circle(color clr, const circle &c)

public void Circle.DrawCircle(Color clr);
public static void SplashKit.DrawCircle(Color clr, Circle c);

def draw_circle_record(clr, c):

procedure DrawCircle(clr: Color; const c: Circle)

Draw Circle

Draw a circle with the provided drawing options, which may include options related to the drawing destination.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
c	`Circle`	The circle being drawn
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void draw_circle(color clr, const circle &c, drawing_options opts)

public void Circle.DrawCircle(Color clr, DrawingOptions opts);
public static void SplashKit.DrawCircle(Color clr, Circle c, DrawingOptions opts);

def draw_circle_record_with_options(clr, c, opts):

procedure DrawCircle(clr: Color; const c: Circle; opts: DrawingOptions)

Draw Circle

Draw a circle onto the current window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void draw_circle(color clr, double x, double y, double radius)

public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius);

def draw_circle(clr, x, y, radius):

procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double)

Draw Circle

Draw a circle using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius. This will use Drawing Options to determine the destination.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void draw_circle(color clr, double x, double y, double radius, drawing_options opts)

public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);

def draw_circle_with_options(clr, x, y, radius, opts):

procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Draw Circle On Bitmap

Draw a circle onto the destination bitmap. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Bitmap`	The destination bitmap
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)

public void Bitmap.DrawCircleOnBitmap(Color clr, double x, double y, double radius);
public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);

def draw_circle_on_bitmap(destination, clr, x, y, radius):

procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)

Draw Circle On Bitmap

Draw a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Bitmap`	The destination bitmap
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)

public void Bitmap.DrawCircleOnBitmap(Color clr, double x, double y, double radius, DrawingOptions opts);
public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);

def draw_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):

procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Draw Circle On Window

Draw a circle onto the destination window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Window`	The destination window
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void draw_circle_on_window(window destination, color clr, double x, double y, double radius)

public void Window.DrawCircleOnWindow(Color clr, double x, double y, double radius);
public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius);

def draw_circle_on_window(destination, clr, x, y, radius):

procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)

Draw Circle On Window

Draw a circle to the window using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Window`	The destination window
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void draw_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)

public void Window.DrawCircleOnWindow(Color clr, double x, double y, double radius, DrawingOptions opts);
public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);

def draw_circle_on_window_with_options(destination, clr, x, y, radius, opts):

procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Fill Circle

Draw a circle on the current window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
c	`Circle`	The circle being drawn

Signatures:

void fill_circle(color clr, const circle &c)

public void Circle.FillCircle(Color clr);
public static void SplashKit.FillCircle(Color clr, Circle c);

def fill_circle_record(clr, c):

procedure FillCircle(clr: Color; const c: Circle)

Fill Circle

Fill a circle with the provided drawing options, which may include options related to the drawing destination.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
c	`Circle`	The circle being drawn
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void fill_circle(color clr, const circle &c, drawing_options opts)

public void Circle.FillCircle(Color clr, DrawingOptions opts);
public static void SplashKit.FillCircle(Color clr, Circle c, DrawingOptions opts);

def fill_circle_record_with_options(clr, c, opts):

procedure FillCircle(clr: Color; const c: Circle; opts: DrawingOptions)

Fill Circle

Fill a circle onto the current window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void fill_circle(color clr, double x, double y, double radius)

public static void SplashKit.FillCircle(Color clr, double x, double y, double radius);

def fill_circle(clr, x, y, radius):

procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double)

Fill Circle

Fill a circle using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius. This will use Drawing Options to determine the destination.

Parameters:

Name	Type	Description
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void fill_circle(color clr, double x, double y, double radius, drawing_options opts)

public static void SplashKit.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);

def fill_circle_with_options(clr, x, y, radius, opts):

procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Fill Circle On Bitmap

Fill a circle onto the destination bitmap. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Bitmap`	The destination bitmap
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)

public void Bitmap.FillCircleOnBitmap(Color clr, double x, double y, double radius);
public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);

def fill_circle_on_bitmap(destination, clr, x, y, radius):

procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)

Fill Circle On Bitmap

Fill a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Bitmap`	The destination bitmap
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)

public void Bitmap.FillCircleOnBitmap(Color clr, double x, double y, double radius, DrawingOptions opts);
public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);

def fill_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):

procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Fill Circle On Window

Fill a circle onto the destination window. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Window`	The destination window
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle

Signatures:

void fill_circle_on_window(window destination, color clr, double x, double y, double radius)

public void Window.FillCircleOnWindow(Color clr, double x, double y, double radius);
public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius);

def fill_circle_on_window(destination, clr, x, y, radius):

procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)

Fill Circle On Window

Fill a circle to the window using the supplied drawing options. The circle is centred on its x, y coordinates, and has the provided radius.

Parameters:

Name	Type	Description
destination	`Window`	The destination window
clr	`Color`	The color of the circle
x	`Double`	The x location of the circle
y	`Double`	The y location of the circle
radius	`Double`	The radius of the circle
opts	`Drawing Options`	Drawing options to configure the drawing operation

Signatures:

void fill_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)

public void Window.FillCircleOnWindow(Color clr, double x, double y, double radius, DrawingOptions opts);
public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);

def fill_circle_on_window_with_options(destination, clr, x, y, radius, opts):

procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)

Current Clip

Returns the rectangle of the current clip area for the current window

Return Type: Rectangle

Signatures:

rectangle current_clip()

public static Rectangle SplashKit.CurrentClip();

def current_clip():

function CurrentClip(): Rectangle

Current Clip

Returns the rectangle of the current clip area for a bitmap

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the clipping rectangle from

Return Type: Rectangle

Signatures:

rectangle current_clip(bitmap bmp)

public static Rectangle SplashKit.CurrentClip(Bitmap bmp);

def current_clip_for_bitmap(bmp):

function CurrentClip(bmp: Bitmap): Rectangle

Current Clip

Returns the rectangle of the current clip area for a window

Parameters:

Name	Type	Description
wnd	`Window`	The window to get the clipping rectangle from

Return Type: Rectangle

Signatures:

rectangle current_clip(window wnd)

public static Rectangle SplashKit.CurrentClip(Window wnd);

def current_clip_for_window(wnd):

function CurrentClip(wnd: Window): Rectangle

Pop Clip

Remove the last clipping rectangle pushed to the window. This will then apply the previously pushed clipping rectangle.

Parameters:

Name	Type	Description
wnd	`Window`	The window to change

Signatures:

void pop_clip(window wnd)

public static void SplashKit.PopClip(Window wnd);

def pop_clip_for_window(wnd):

procedure PopClip(wnd: Window)

Pop Clip

Remove the last clipping rectangle pushed to the current window. This will then apply the previously pushed clipping rectangle.

Signatures:

void pop_clip()

public static void SplashKit.PopClip();

def pop_clip():

procedure PopClip()

Pop Clip

Remove the last clipping rectangle pushed to the bitmap. This will then apply the previously pushed clipping rectangle.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to change

Signatures:

void pop_clip(bitmap bmp)

public static void SplashKit.PopClip(Bitmap bmp);

def pop_clip_for_bitmap(bmp):

procedure PopClip(bmp: Bitmap)

Add the clipping rectangle of a window and uses the intersect between the new rectangle and previous clip. When a clipping rectangle is provided, drawing operations will only affect the area specified in the current clipping rectangle.

Parameters:

Name	Type	Description
wnd	`Window`	The window to add clipping to
r	`Rectangle`	The new clipping rectangle

Signatures:

void push_clip(window wnd, const rectangle &r)

public static void SplashKit.PushClip(Window wnd, Rectangle r);

def push_clip_for_window(wnd, r):

procedure PushClip(wnd: Window; const r: Rectangle)

Push Clip

Add the clipping rectangle of a bitmap and uses the intersect between the new rectangle and previous clip. When a clipping rectangle is provided, drawing operations will only affect the area specified in the current clipping rectangle.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to add clipping to
r	`Rectangle`	The new clipping rectangle

Signatures:

void push_clip(bitmap bmp, const rectangle &r)

public static void SplashKit.PushClip(Bitmap bmp, Rectangle r);

def push_clip_for_bitmap(bmp, r):

procedure PushClip(bmp: Bitmap; const r: Rectangle)

Push Clip

Push a clip rectangle to the current window. The resulting clipping rectangle will be the intersection of the existing clipping rectangle with the new rectangle provided in this call. This can be undone using Pop Clip. When a clipping rectangle is provided, drawing operations will only affect the area specified in the current clipping rectangle.

Parameters:

Name	Type	Description
r	`Rectangle`	The new clipping rectangle

Signatures:

void push_clip(const rectangle &r)

public static void SplashKit.PushClip(Rectangle r);

def push_clip(r):

procedure PushClip(const r: Rectangle)

Reset Clip

Reset the clipping rectangle on a bitmap. This will clear all of the clipping rectangles pushed to the bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to clear the clipping rectangle

Signatures:

void reset_clip(bitmap bmp)

public static void SplashKit.ResetClip(Bitmap bmp);

def reset_clip_for_bitmap(bmp):

procedure ResetClip(bmp: Bitmap)

Reset Clip

Reset the clipping rectangle of the current window. This will clear all of the clipping rectangles pushed to the current window.

Signatures:

void reset_clip()

public static void SplashKit.ResetClip();

def reset_clip():

procedure ResetClip()

Reset Clip

Reset the clipping rectangle on a window. This will clear all of the clipping rectangles pushed to the window.

Parameters:

Name	Type	Description
wnd	`Window`	The window to clear the clipping rectangle

Signatures:

void reset_clip(window wnd)

public static void SplashKit.ResetClip(Window wnd);

def reset_clip_for_window(wnd):

procedure ResetClip(wnd: Window)

Set Clip

Set the clip rectangle of the current window. This will clear any existing clipping rectangles pushed to the current window, and use the supplied rectangle for clipping.

Parameters:

Name	Type	Description
r	`Rectangle`	The new clipping rectangle

Signatures:

void set_clip(const rectangle &r)

public static void SplashKit.SetClip(Rectangle r);

def set_clip(r):

procedure SetClip(const r: Rectangle)

Set Clip

Set the clip rectangle of the bitmap. This will clear any existing clipping rectangles pushed to the bitmap, and use the supplied rectangle for clipping.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to change
r	`Rectangle`	The new clipping rectangle

Signatures:

void set_clip(bitmap bmp, const rectangle &r)

public static void SplashKit.SetClip(Bitmap bmp, Rectangle r);

def set_clip_for_bitmap(bmp, r):

procedure SetClip(bmp: Bitmap; const r: Rectangle)

Set Clip

Set the clip rectangle of the window. This will clear any existing clipping rectangles pushed to the window, and use the supplied rectangle for clipping.

Parameters:

Name	Type	Description
wnd	`Window`	The window to change
r	`Rectangle`	The new clipping rectangle

Signatures:

void set_clip(window wnd, const rectangle &r)

public static void SplashKit.SetClip(Window wnd, Rectangle r);

def set_clip_for_window(wnd, r):

procedure SetClip(wnd: Window; const r: Rectangle)

Option Defaults

Returns a Drawing Options with default values. This will draw to the current window, with default scale of 1, no rotation or offset, not flipped, drawing whole images, with default camera mechanisms and line width.

Return Type: Drawing Options

Signatures:

drawing_options option_defaults()

public static DrawingOptions SplashKit.OptionDefaults();

def option_defaults():

function OptionDefaults(): DrawingOptions

Option Draw To

Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on.

Parameters:

Name	Type	Description
dest	`Bitmap`	The bitmap to draw to.

Return Type: Drawing Options

Signatures:

drawing_options option_draw_to(bitmap dest)

public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest);

def option_draw_to_bitmap(dest):

function OptionDrawTo(dest: Bitmap): DrawingOptions

Option Draw To

Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on. Pass opts the other options you want use.

Parameters:

Name	Type	Description
dest	`Bitmap`	The bitmap to draw to.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_draw_to(bitmap dest, drawing_options opts)

public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest, DrawingOptions opts);

def option_draw_to_bitmap_with_options(dest, opts):

function OptionDrawTo(dest: Bitmap; opts: DrawingOptions): DrawingOptions

Option Draw To

Use this option to draw to a specified Window. Pass dest the Window you want to draw on.

Parameters:

Name	Type	Description
dest	`Window`	The window to draw onto.

Return Type: Drawing Options

Signatures:

drawing_options option_draw_to(window dest)

public static DrawingOptions SplashKit.OptionDrawTo(Window dest);

def option_draw_to_window(dest):

function OptionDrawTo(dest: Window): DrawingOptions

Option Draw To

Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on to. Pass opts the other options you want use.

Parameters:

Name	Type	Description
dest	`Window`	The window to draw onto.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_draw_to(window dest, drawing_options opts)

public static DrawingOptions SplashKit.OptionDrawTo(Window dest, DrawingOptions opts);

def option_draw_to_window_with_options(dest, opts):

function OptionDrawTo(dest: Window; opts: DrawingOptions): DrawingOptions

Option Flip X

Use this option to flip an image along its X axis.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_x()

public static DrawingOptions SplashKit.OptionFlipX();

def option_flip_x():

function OptionFlipX(): DrawingOptions

Option Flip X

Use this option to flip an image along its X axis.

Parameters:

Name	Type	Description
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_x(drawing_options opts)

public static DrawingOptions SplashKit.OptionFlipX(DrawingOptions opts);

def option_flip_x_with_options(opts):

function OptionFlipX(opts: DrawingOptions): DrawingOptions

Option Flip Xy

Use this option to flip the drawing of an image along both X and Y axis.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_xy()

public static DrawingOptions SplashKit.OptionFlipXy();

def option_flip_xy():

function OptionFlipXy(): DrawingOptions

Option Flip Xy

Use this option to flip the drawing of an image along both X and Y axis.

Parameters:

Name	Type	Description
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_xy(drawing_options opts)

public static DrawingOptions SplashKit.OptionFlipXy(DrawingOptions opts);

def option_flip_xy_with_options(opts):

function OptionFlipXy(opts: DrawingOptions): DrawingOptions

Option Flip Y

Use this option to flip the drawing of an image along its Y axis.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_y()

public static DrawingOptions SplashKit.OptionFlipY();

def option_flip_y():

function OptionFlipY(): DrawingOptions

Option Flip Y

Use this option to flip the drawing of an image along its Y axis.

Parameters:

Name	Type	Description
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_flip_y(drawing_options opts)

public static DrawingOptions SplashKit.OptionFlipY(DrawingOptions opts);

def option_flip_y_with_options(opts):

function OptionFlipY(opts: DrawingOptions): DrawingOptions

Option Line Width

Use this option to change the width of line drawings.

Parameters:

Name	Type	Description
width	`Integer`	The new line width for line drawing.

Return Type: Drawing Options

Signatures:

drawing_options option_line_width(int width)

public static DrawingOptions SplashKit.OptionLineWidth(int width);

def option_line_width(width):

function OptionLineWidth(width: Integer): DrawingOptions

Option Line Width

Use this option to change the width of line drawings.

Parameters:

Name	Type	Description
width	`Integer`	The new line width for line drawing.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_line_width(int width, drawing_options opts)

public static DrawingOptions SplashKit.OptionLineWidth(int width, DrawingOptions opts);

def option_line_width_with_options(width, opts):

function OptionLineWidth(width: Integer; opts: DrawingOptions): DrawingOptions

Option Part Bmp

Use this option to draw only a part of a bitmap.

Parameters:

Name	Type	Description
x	`Double`	The x coordinate of the part within the bitmap.
y	`Double`	The y coordinate of the part within the bitmap.
w	`Double`	The width of the part within the bitmap.
h	`Double`	The height of the part within the bitmap.

Return Type: Drawing Options

Signatures:

drawing_options option_part_bmp(double x, double y, double w, double h)

public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h);

def option_part_bmp(x, y, w, h):

function OptionPartBmp(x: Double; y: Double; w: Double; h: Double): DrawingOptions

Option Part Bmp

Use this option to draw only a part of a bitmap.

Parameters:

Name	Type	Description
x	`Double`	The x coordinate of the part within the bitmap.
y	`Double`	The y coordinate of the part within the bitmap.
w	`Double`	The width of the part within the bitmap.
h	`Double`	The height of the part within the bitmap.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_part_bmp(double x, double y, double w, double h, drawing_options opts)

public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h, DrawingOptions opts);

def option_part_bmp_with_options(x, y, w, h, opts):

function OptionPartBmp(x: Double; y: Double; w: Double; h: Double; opts: DrawingOptions): DrawingOptions

Option Part Bmp

Use this option to draw only part of a bitmap.

Parameters:

Name	Type	Description
part	`Rectangle`	The rectangle of the part of the bitmap to draw.

Return Type: Drawing Options

Signatures:

drawing_options option_part_bmp(rectangle part)

public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part);

def option_part_bmp_from_rectangle(part):

function OptionPartBmp(part: Rectangle): DrawingOptions

Option Part Bmp

Use this option to draw only part of a bitmap.

Parameters:

Name	Type	Description
part	`Rectangle`	The rectangle of the part of the bitmap to draw.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_part_bmp(rectangle part, drawing_options opts)

public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part, DrawingOptions opts);

def option_part_bmp_from_rectangle_with_options(part, opts):

function OptionPartBmp(part: Rectangle; opts: DrawingOptions): DrawingOptions

Option Rotate Bmp

Use this option to rotate a bitmap around its centre point.

Parameters:

Name	Type	Description
angle	`Double`	The angle to rotate bitmaps.

Return Type: Drawing Options

Signatures:

drawing_options option_rotate_bmp(double angle)

public static DrawingOptions SplashKit.OptionRotateBmp(double angle);

def option_rotate_bmp(angle):

function OptionRotateBmp(angle: Double): DrawingOptions

Option Rotate Bmp

Use this option to rotate the drawing of a bitmap. This allows you to set the anchor point and rotate around that by a number of degrees. Pass opts the other options you want use.

Parameters:

Name	Type	Description
angle	`Double`	The angle to rotate bitmaps.
anchor_x	`Double`	The x location of the anchor within the bitmap
anchor_y	`Double`	The y location of the anchor within the bitmap

Return Type: Drawing Options

Signatures:

drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y)

public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY);

def option_rotate_bmp_with_anchor(angle, anchor_x, anchor_y):

function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double): DrawingOptions

Option Rotate Bmp

Use this option to rotate the drawing of a bitmap. This allows you to set the anchor point and rotate around that by a number of degrees. Pass opts the other options you want use.

Parameters:

Name	Type	Description
angle	`Double`	The angle to rotate bitmaps.
anchor_x	`Double`	The x location of the anchor within the bitmap
anchor_y	`Double`	The y location of the anchor within the bitmap
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y, drawing_options opts)

public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY, DrawingOptions opts);

def option_rotate_bmp_with_anchor_and_options(angle, anchor_x, anchor_y, opts):

function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double; opts: DrawingOptions): DrawingOptions

Option Rotate Bmp

Use this option to rotate a bitmap around its centre point.

Parameters:

Name	Type	Description
angle	`Double`	The angle to rotate bitmaps.
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_rotate_bmp(double angle, drawing_options opts)

public static DrawingOptions SplashKit.OptionRotateBmp(double angle, DrawingOptions opts);

def option_rotate_bmp_with_options(angle, opts):

function OptionRotateBmp(angle: Double; opts: DrawingOptions): DrawingOptions

Option Scale Bmp

Use this option to scale the drawing of bitmaps. You can scale x and y separately.

Parameters:

Name	Type	Description
scale_x	`Double`	The amount to scale bitmaps aalong the x axis
scale_y	`Double`	The amount to scale bitmaps aalong the y axis

Return Type: Drawing Options

Signatures:

drawing_options option_scale_bmp(double scale_x, double scale_y)

public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY);

def option_scale_bmp(scale_x, scale_y):

function OptionScaleBmp(scaleX: Double; scaleY: Double): DrawingOptions

Option Scale Bmp

Use this option to scale the drawing of bitmaps. You can scale x and y separately. Pass opts the other options you want use.

Parameters:

Name	Type	Description
scale_x	`Double`	The amount to scale bitmaps aalong the x axis
scale_y	`Double`	The amount to scale bitmaps aalong the y axis
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_scale_bmp(double scale_x, double scale_y, drawing_options opts)

public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY, DrawingOptions opts);

def option_scale_bmp_with_options(scale_x, scale_y, opts):

function OptionScaleBmp(scaleX: Double; scaleY: Double; opts: DrawingOptions): DrawingOptions

Option To Screen

Use this option to draw to the screen, ignoring the positon of the camera.

Return Type: Drawing Options

Signatures:

drawing_options option_to_screen()

public static DrawingOptions SplashKit.OptionToScreen();

def option_to_screen():

function OptionToScreen(): DrawingOptions

Option To Screen

Use this option to draw to the screen, ignoring the positon of the camera.

Parameters:

Name	Type	Description
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_to_screen(drawing_options opts)

public static DrawingOptions SplashKit.OptionToScreen(DrawingOptions opts);

def option_to_screen_with_options(opts):

function OptionToScreen(opts: DrawingOptions): DrawingOptions

Option To World

Use this option to draw in World coordinates — these are affected by the movement of the camera.

Return Type: Drawing Options

Signatures:

drawing_options option_to_world()

public static DrawingOptions SplashKit.OptionToWorld();

def option_to_world():

function OptionToWorld(): DrawingOptions

Option To World

Use this option to draw in World coordinates — these are affected by the movement of the camera.

Parameters:

Name	Type	Description
opts	`Drawing Options`	Values for the other options.

Return Type: Drawing Options

Signatures:

drawing_options option_to_world(drawing_options opts)

public static DrawingOptions SplashKit.OptionToWorld(DrawingOptions opts);

def option_to_world_with_options(opts):

function OptionToWorld(opts: DrawingOptions): DrawingOptions

Option With Animation

Use details from the animation to select an appropriate cell from the bitmaps being drawn.

Parameters:

Name	Type	Description
anim	`Animation`	The animation with the cell details to be used.

Return Type: Drawing Options

Signatures:

drawing_options option_with_animation(animation anim)

public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim);

def option_with_animation(anim):

function OptionWithAnimation(anim: Animation): DrawingOptions

Option With Animation

Use details from the animation to select an appropriate cell from the bitmaps being drawn. This extends the passed in drawing options with the animation details.

Parameters:

Name	Type	Description
anim	`Animation`	The animation with the cell details to be used.
opts	`Drawing Options`	The existing options to extend.

Return Type: Drawing Options

Signatures:

drawing_options option_with_animation(animation anim, drawing_options opts)

public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim, DrawingOptions opts);

def option_with_animation_with_options(anim, opts):

function OptionWithAnimation(anim: Animation; opts: DrawingOptions): DrawingOptions

Option With Bitmap Cell

When drawing the bitmap this will only draw the cell. To use this the bitmap needs to have been provided with its cell details (see Bitmap Set Cell Details). This option overrides the animation or part drawing options.

Parameters:

Name	Type	Description
cell	`Integer`	The cell to draw from the bitmap (-1 for entire bitmap)

Return Type: Drawing Options

Signatures:

drawing_options option_with_bitmap_cell(int cell)

public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell);

def option_with_bitmap_cell(cell):

function OptionWithBitmapCell(cell: Integer): DrawingOptions

Option With Bitmap Cell

Parameters:

Name	Type	Description
cell	`Integer`	The cell to draw from the bitmap (-1 for entire bitmap)
opts	`Drawing Options`	The existing options to extend.

Return Type: Drawing Options

Signatures:

drawing_options option_with_bitmap_cell(int cell, drawing_options opts)

public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell, DrawingOptions opts);

def option_with_bitmap_cell_with_options(cell, opts):

function OptionWithBitmapCell(cell: Integer; opts: DrawingOptions): DrawingOptions

Draw Ellipse

Draws an ellipse using the provided location, and size.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void draw_ellipse(color clr, const rectangle rect)

public static void SplashKit.DrawEllipse(Color clr, Rectangle rect);

def draw_ellipse_within_rectangle(clr, rect):

procedure DrawEllipse(clr: Color; rect: Rectangle)

Draw Ellipse

Draws an ellipse using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse(color clr, const rectangle rect, drawing_options opts)

public static void SplashKit.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);

def draw_ellipse_within_rectangle_with_options(clr, rect, opts):

procedure DrawEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)

Draw Ellipse

Draws an ellipse using the provided location, and size.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void draw_ellipse(color clr, double x, double y, double width, double height)

public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height);

def draw_ellipse(clr, x, y, width, height):

procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)

Draw Ellipse

Draws an ellipse using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)

public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);

def draw_ellipse_with_options(clr, x, y, width, height, opts):

procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Draw Ellipse On Bitmap

Draws an ellipse on the given bitmap, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)

public void Bitmap.DrawEllipseOnBitmap(Color clr, Rectangle rect);
public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);

def draw_ellipse_on_bitmap_within_rectangle(destination, clr, rect):

procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)

Draw Ellipse On Bitmap

Draws an ellipse on the given bitmap, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)

public void Bitmap.DrawEllipseOnBitmap(Color clr, Rectangle rect, DrawingOptions opts);
public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);

def draw_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):

procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)

Draw Ellipse On Bitmap

Draws an ellipse on the given bitmap, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or bitmap to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or bitmap to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)

public void Bitmap.DrawEllipseOnBitmap(Color clr, double x, double y, double width, double height);
public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);

def draw_ellipse_on_bitmap(destination, clr, x, y, width, height):

procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)

Draw Ellipse On Bitmap

Draws an ellipse to the bitmap, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or bitmap to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or bitmap to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)

public void Bitmap.DrawEllipseOnBitmap(Color clr, double x, double y, double width, double height, DrawingOptions opts);
public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);

def draw_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):

procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Draw Ellipse On Window

Draws an ellipse on the given window, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void draw_ellipse_on_window(window destination, color clr, const rectangle rect)

public void Window.DrawEllipseOnWindow(Color clr, Rectangle rect);
public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect);

def draw_ellipse_on_window_within_rectangle(destination, clr, rect):

procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)

Draw Ellipse On Window

Draws an ellipse on the given window, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)

public void Window.DrawEllipseOnWindow(Color clr, Rectangle rect, DrawingOptions opts);
public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);

def draw_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):

procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)

Draw Ellipse On Window

Draws an ellipse on the given window, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)

public void Window.DrawEllipseOnWindow(Color clr, double x, double y, double width, double height);
public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);

def draw_ellipse_on_window(destination, clr, x, y, width, height):

procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)

Draw Ellipse On Window

Draws an ellipse to the window, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)

public void Window.DrawEllipseOnWindow(Color clr, double x, double y, double width, double height, DrawingOptions opts);
public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);

def draw_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):

procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Fill Ellipse

Fill an ellipse using the provided location, and size.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void fill_ellipse(color clr, const rectangle rect)

public static void SplashKit.FillEllipse(Color clr, Rectangle rect);

def fill_ellipse_within_rectangle(clr, rect):

procedure FillEllipse(clr: Color; rect: Rectangle)

Fill Ellipse

Fills an ellipse using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse(color clr, const rectangle rect, drawing_options opts)

public static void SplashKit.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);

def fill_ellipse_within_rectangle_with_options(clr, rect, opts):

procedure FillEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)

Fill Ellipse

Fills an ellipse using the provided location, and size.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void fill_ellipse(color clr, double x, double y, double width, double height)

public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height);

def fill_ellipse(clr, x, y, width, height):

procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)

Fill Ellipse

Fills an ellipse using the provided location, size, and drawing options.

Parameters:

Name	Type	Description
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)

public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);

def fill_ellipse_with_options(clr, x, y, width, height, opts):

procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Fill Ellipse On Bitmap

Fill an ellipse on the given bitmap, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)

public void Bitmap.FillEllipseOnBitmap(Color clr, Rectangle rect);
public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);

def fill_ellipse_on_bitmap_within_rectangle(destination, clr, rect):

procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)

Fill Ellipse On Bitmap

Fills an ellipse on the given bitmap, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)

public void Bitmap.FillEllipseOnBitmap(Color clr, Rectangle rect, DrawingOptions opts);
public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);

def fill_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):

procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)

Fill Ellipse On Bitmap

Fills an ellipse on the given bitmap, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or bitmap to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or bitmap to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)

public void Bitmap.FillEllipseOnBitmap(Color clr, double x, double y, double width, double height);
public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);

def fill_ellipse_on_bitmap(destination, clr, x, y, width, height):

procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)

Fill Ellipse On Bitmap

Fills an ellipse on the given bitmap, using the provided location, size, and drawing options.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or bitmap to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or bitmap to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)

public void Bitmap.FillEllipseOnBitmap(Color clr, double x, double y, double width, double height, DrawingOptions opts);
public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);

def fill_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):

procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Fill Ellipse On Window

Fill an ellipse on the given window, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse

Signatures:

void fill_ellipse_on_window(window destination, color clr, const rectangle rect)

public void Window.FillEllipseOnWindow(Color clr, Rectangle rect);
public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect);

def fill_ellipse_on_window_within_rectangle(destination, clr, rect):

procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)

Fill Ellipse On Window

Fills an ellipse on the given window, using the provided location, size, and drawing options. At this stage ellipse drawing is not affected by line width from the drawing options.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
rect	`Rectangle`	Indicates the location and size of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)

public void Window.FillEllipseOnWindow(Color clr, Rectangle rect, DrawingOptions opts);
public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);

def fill_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):

procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)

Fill Ellipse On Window

Fills an ellipse on the given window, using the provided location, and size.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse

Signatures:

void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)

public void Window.FillEllipseOnWindow(Color clr, double x, double y, double width, double height);
public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);

def fill_ellipse_on_window(destination, clr, x, y, width, height):

procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)

Fill Ellipse On Window

Fills an ellipse on the given window, using the provided location, size, and drawing options.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the ellipse on
clr	`Color`	The color of the ellipse
x	`Double`	The distance from the left of the bitmap or window to the left edge of the ellipse
y	`Double`	The distance from the top of the bitmap or window to the top edge of the ellipse
width	`Double`	The width of the ellipse
height	`Double`	The height of the ellipse
opts	`Drawing Options`	The drawing options

Signatures:

void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)

public void Window.FillEllipseOnWindow(Color clr, double x, double y, double width, double height, DrawingOptions opts);
public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);

def fill_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):

procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)

Clear Screen

Clears the current screen to color white.

Signatures:

void clear_screen()

public static void SplashKit.ClearScreen();

def clear_screen_to_white():

procedure ClearScreen()

Clear Screen

Parameters:

Name	Type	Description
clr	`Color`	The color to clear the screen’s background color to.

Signatures:

void clear_screen(color clr)

public static void SplashKit.ClearScreen(Color clr);

def clear_screen(clr):

procedure ClearScreen(clr: Color)

Display Details

Returns the details about one of the displays attached to the computer.

Parameters:

Name	Type	Description
index	unsigned int	The display number (from 0 to `Number Of Displays` - 1)

Return Type: Display

Signatures:

display display_details(unsigned int index)

public static Display SplashKit.DisplayDetails(uint index);

def display_details(index):

function DisplayDetails(index: Cardinal): Display

Display Height

Return the height of the display in pixels, read from the system details.

Parameters:

Name	Type	Description
disp	`Display`	The display details

Return Type: Integer

Signatures:

int display_height(display disp)

public int Display.Height { get }
public static int SplashKit.DisplayHeight(Display disp);

def display_height(disp):

function DisplayHeight(disp: Display): Integer

Display Name

Return the name of the display, read from the system details.

Parameters:

Name	Type	Description
disp	`Display`	The display details

Return Type: String

Signatures:

string display_name(display disp)

public string Display.Name { get }
public static string SplashKit.DisplayName(Display disp);

def display_name(disp):

function DisplayName(disp: Display): String

Display Width

Return the width of the display in pixels, read from the system details.

Parameters:

Name	Type	Description
disp	`Display`	The display details

Return Type: Integer

Signatures:

int display_width(display disp)

public int Display.Width { get }
public static int SplashKit.DisplayWidth(Display disp);

def display_width(disp):

function DisplayWidth(disp: Display): Integer

Display X

Return a relative x location for the display in pixels, read from the system details. This can be used to work out the arrangement of displays.

Parameters:

Name	Type	Description
disp	`Display`	The display details

Return Type: Integer

Signatures:

int display_x(display disp)

public int Display.X { get }
public static int SplashKit.DisplayX(Display disp);

def display_x(disp):

function DisplayX(disp: Display): Integer

Display Y

Return a relative y location for the display in pixels, read from the system details. This can be used to work out the arrangement of displays.

Parameters:

Name	Type	Description
disp	`Display`	The display details

Return Type: Integer

Signatures:

int display_y(display disp)

public int Display.Y { get }
public static int SplashKit.DisplayY(Display disp);

def display_y(disp):

function DisplayY(disp: Display): Integer

Number Of Displays

Returns the number of physical displays attached to the computer.

Return Type: Integer

Signatures:

int number_of_displays()

public static int SplashKit.NumberOfDisplays();

def number_of_displays():

function NumberOfDisplays(): Integer

Refresh Screen

Signatures:

void refresh_screen()

public static void SplashKit.RefreshScreen();

def refresh_screen():

procedure RefreshScreen()

Refresh Screen

Refreshes all open windows with a target FPS (frames per second). This will delay a period of time that will approximately meet the targeted frames per second.

Parameters:

Name	Type	Description
target_fps	unsigned int	The targeted frames per second to refresh the screen at.

Signatures:

void refresh_screen(unsigned int target_fps)

public static void SplashKit.RefreshScreen(uint targetFps);

def refresh_screen_with_target_fps(target_fps):

procedure RefreshScreen(targetFps: Cardinal)

Save Bitmap

Save the bitmap to the user’s desktop.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to save
basename	`String`	The base of the filename. If there is a file of this name already, then the name will be changed to generate a unique filename.

Signatures:

void save_bitmap(bitmap bmp, const string &basename)

public static void SplashKit.SaveBitmap(Bitmap bmp, string basename);

def save_bitmap(bmp, basename):

procedure SaveBitmap(bmp: Bitmap; const basename: String)

Screen Height

Returns the height of the current window.

Return Type: Integer

Signatures:

int screen_height()

public static int SplashKit.ScreenHeight();

def screen_height():

function ScreenHeight(): Integer

Screen Width

Returns the width of the current window.

Return Type: Integer

Signatures:

int screen_width()

public static int SplashKit.ScreenWidth();

def screen_width():

function ScreenWidth(): Integer

Take Screenshot

Saves a screenshot of the current window to a bitmap file. The file will be saved onto the user’s desktop.

Parameters:

Name	Type	Description
basename	`String`	The base of the filename. If there is a file of this name already, then the name will be changed to generate a unique filename.

Signatures:

void take_screenshot(const string &basename)

public static void SplashKit.TakeScreenshot(string basename);

def take_screenshot(basename):

procedure TakeScreenshot(const basename: String)

Take Screenshot

Saves a screenshot of the current window to a bitmap file. The file will be saved onto the user’s desktop.

Parameters:

Name	Type	Description
wind	`Window`	The window to capture in the screenshot
basename	`String`	The base of the filename. If there is a file of this name already, then the name will be changed to generate a unique filename.

Signatures:

void take_screenshot(window wind, const string &basename)

public static void SplashKit.TakeScreenshot(Window wind, string basename);

def take_screenshot_of_window(wind, basename):

procedure TakeScreenshot(wind: Window; const basename: String)

Bitmap Bounding Circle

Returns a circle that will encompass the entire bitamp.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to encompass.
pt	`Point 2d`	The point where the bitmap is located.

Return Type: Circle

Signatures:

circle bitmap_bounding_circle(bitmap bmp, const point_2d &pt)

public Circle Bitmap.BitmapBoundingCircle(Point2D pt);
public static Circle SplashKit.BitmapBoundingCircle(Bitmap bmp, Point2D pt);

def bitmap_bounding_circle(bmp, pt):

function BitmapBoundingCircle(bmp: Bitmap; const pt: Point2D): Circle

Bitmap Bounding Rectangle

Returns a rectangle that is the same size as a bitmap (the whole bitmap).

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap

Return Type: Rectangle

Signatures:

rectangle bitmap_bounding_rectangle(bitmap bmp)

public Rectangle Bitmap.BitmapBoundingRectangle();
public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp);

def bitmap_bounding_rectangle(bmp):

function BitmapBoundingRectangle(bmp: Bitmap): Rectangle

Bitmap Bounding Rectangle

Returns a rectangle that is the same size as the bitmap and is located at the indicated position.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap
x	`Double`	The x location of the rectangle
y	`Double`	The y location of the rectangle

Return Type: Rectangle

Signatures:

rectangle bitmap_bounding_rectangle(bitmap bmp, double x, double y)

public Rectangle Bitmap.BitmapBoundingRectangle(double x, double y);
public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp, double x, double y);

def bitmap_bounding_rectangle_at_location(bmp, x, y):

function BitmapBoundingRectangle(bmp: Bitmap; x: Double; y: Double): Rectangle

Bitmap Cell Center

This returns a point that represents the center of a cell from this bitmap in local space.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the center of.

Return Type: Point 2d

Signatures:

point_2d bitmap_cell_center(bitmap bmp)

public Point2D Bitmap.CellCenter { get }
public static Point2D SplashKit.BitmapCellCenter(Bitmap bmp);

def bitmap_cell_center(bmp):

function BitmapCellCenter(bmp: Bitmap): Point2D

Bitmap Cell Circle

Returns a circle that will encompass the bitmap cell if it were drawn at the indicated point.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.
x	`Double`	The the x location of the bitmap.
y	`Double`	The the y location of the bitmap.

Return Type: Circle

Signatures:

circle bitmap_cell_circle(bitmap bmp, double x, double y)

public Circle Bitmap.BitmapCellCircle(double x, double y);
public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, double x, double y);

def bitmap_cell_circle(bmp, x, y):

function BitmapCellCircle(bmp: Bitmap; x: Double; y: Double): Circle

Bitmap Cell Circle

Returns a circle that will encompass the bitmap cell if it were drawn at the indicated point.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.
pt	`Point 2d`	The point indicating the location of the bitmap.

Return Type: Circle

Signatures:

circle bitmap_cell_circle(bitmap bmp, const point_2d pt)

public Circle Bitmap.BitmapCellCircle(Point2D pt);
public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt);

def bitmap_cell_circle_at_point(bmp, pt):

function BitmapCellCircle(bmp: Bitmap; pt: Point2D): Circle

Bitmap Cell Circle

Returns a circle that will encompass the bitmap cell if it were drawn at the indicated point, with the provided scale.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.
pt	`Point 2d`	The point indicating the location of the bitmap.
scale	`Double`	The scaling factor for the bitmap drawing.

Return Type: Circle

Signatures:

circle bitmap_cell_circle(bitmap bmp, const point_2d pt, double scale)

public Circle Bitmap.BitmapCellCircle(Point2D pt, double scale);
public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt, double scale);

def bitmap_cell_circle_at_point_with_scale(bmp, pt, scale):

function BitmapCellCircle(bmp: Bitmap; pt: Point2D; scale: Double): Circle

Bitmap Cell Columns

Returns the number of cell columns in the bitmap. This is setup using Bitmap Set Cell Details

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to check

Return Type: Integer

Signatures:

int bitmap_cell_columns(bitmap bmp)

public int Bitmap.CellColumns { get }
public static int SplashKit.BitmapCellColumns(Bitmap bmp);

def bitmap_cell_columns(bmp):

function BitmapCellColumns(bmp: Bitmap): Integer

Bitmap Cell Count

Returns the number of cells within the bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to check.

Return Type: Integer

Signatures:

int bitmap_cell_count(bitmap bmp)

public int Bitmap.CellCount { get }
public static int SplashKit.BitmapCellCount(Bitmap bmp);

def bitmap_cell_count(bmp):

function BitmapCellCount(bmp: Bitmap): Integer

Bitmap Cell Height

Returns the height of each cell in this bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.

Return Type: Integer

Signatures:

int bitmap_cell_height(bitmap bmp)

public int Bitmap.CellHeight { get }
public static int SplashKit.BitmapCellHeight(Bitmap bmp);

def bitmap_cell_height(bmp):

function BitmapCellHeight(bmp: Bitmap): Integer

Bitmap Cell Offset

Returns a vector that represents the movement needed to get to a given cell within a bitmap.

Parameters:

Name	Type	Description
src	`Bitmap`	The bitmap with the cell details.
cell	`Integer`	The index of the cell

Return Type: Vector 2d

Signatures:

vector_2d bitmap_cell_offset(bitmap src, int cell)

public Vector2D Bitmap.BitmapCellOffset(int cell);
public static Vector2D SplashKit.BitmapCellOffset(Bitmap src, int cell);

def bitmap_cell_offset(src, cell):

function BitmapCellOffset(src: Bitmap; cell: Integer): Vector2D

Bitmap Cell Rectangle

Returns a rectangle that will encompass a cell of the bitmap.

Parameters:

Name	Type	Description
src	`Bitmap`	The bitmap to get the details from

Return Type: Rectangle

Signatures:

rectangle bitmap_cell_rectangle(bitmap src)

public Rectangle Bitmap.BitmapCellRectangle();
public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src);

def bitmap_cell_rectangle(src):

function BitmapCellRectangle(src: Bitmap): Rectangle

Bitmap Cell Rectangle

Returns a rectangle that will encompass the bitmap cell if it were drawn at the indicated point.

Parameters:

Name	Type	Description
src	`Bitmap`	The bitmap to get the details from
pt	`Point 2d`	The point details for the rectangle.

Return Type: Rectangle

Signatures:

rectangle bitmap_cell_rectangle(bitmap src, const point_2d &pt)

public Rectangle Bitmap.BitmapCellRectangle(Point2D pt);
public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src, Point2D pt);

def bitmap_cell_rectangle_at_point(src, pt):

function BitmapCellRectangle(src: Bitmap; const pt: Point2D): Rectangle

Bitmap Cell Rows

Returns the number of rows of cells in the bitmap. These details are set in Bitmap Set Cell Details.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.

Return Type: Integer

Signatures:

int bitmap_cell_rows(bitmap bmp)

public int Bitmap.CellRows { get }
public static int SplashKit.BitmapCellRows(Bitmap bmp);

def bitmap_cell_rows(bmp):

function BitmapCellRows(bmp: Bitmap): Integer

Bitmap Cell Width

Returns the width of each cell in this bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.

Return Type: Integer

Signatures:

int bitmap_cell_width(bitmap bmp)

public int Bitmap.CellWidth { get }
public static int SplashKit.BitmapCellWidth(Bitmap bmp);

def bitmap_cell_width(bmp):

function BitmapCellWidth(bmp: Bitmap): Integer

Bitmap Center

This returns a point that represents the center of the bitmap in local space.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the center of.

Return Type: Point 2d

Signatures:

point_2d bitmap_center(bitmap bmp)

public Point2D Bitmap.Center { get }
public static Point2D SplashKit.BitmapCenter(Bitmap bmp);

def bitmap_center(bmp):

function BitmapCenter(bmp: Bitmap): Point2D

Bitmap Filename

Returns the filename from which the bitmap was loaded. This will be an empty string for created bitmaps.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the filename from.

Return Type: String

Signatures:

string bitmap_filename(bitmap bmp)

public string Bitmap.Filename { get }
public static string SplashKit.BitmapFilename(Bitmap bmp);

def bitmap_filename(bmp):

function BitmapFilename(bmp: Bitmap): String

Bitmap Height

Returns the total height of the bitmap. If the bitmap contains cells, you ca get the height of a cell using Bitmap Cell Height.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the details from.

Return Type: Integer

Signatures:

int bitmap_height(bitmap bmp)

public int Bitmap.Height { get }
public static int SplashKit.BitmapHeight(Bitmap bmp);

def bitmap_height(bmp):

function BitmapHeight(bmp: Bitmap): Integer

Bitmap Height

Returns the total height of the bitmap. If the bitmap contains cells, you ca get the height of a cell using Bitmap Cell Height.

Parameters:

Name	Type	Description
name	`String`	The name of the bitmap to get the details from.

Return Type: Integer

Signatures:

int bitmap_height(string name)

public static int Images.BitmapHeight(string name);
public static int SplashKit.BitmapHeight(string name);

def bitmap_height_of_bitmap_named(name):

function BitmapHeight(name: String): Integer

Bitmap Name

Returns the name of the bitmap was loaded. This is the name you can use to access this bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap to get the name from.

Return Type: String

Signatures:

string bitmap_name(bitmap bmp)

public string Bitmap.Name { get }
public static string SplashKit.BitmapName(Bitmap bmp);

def bitmap_name(bmp):

function BitmapName(bmp: Bitmap): String

Bitmap Named

Returns the Bitmap that has been loaded with the specified name, see Load Bitmap. This will attempt to load the bitmap if it has not been loaded.

Parameters:

Name	Type	Description
name	`String`	The name of the bitmap to check.

Return Type: Bitmap

Signatures:

bitmap bitmap_named(string name)

public static Bitmap Images.BitmapNamed(string name);
public static Bitmap SplashKit.BitmapNamed(string name);

def bitmap_named(name):

function BitmapNamed(name: String): Bitmap

Bitmap Rectangle Of Cell

Returns a rectangle that can be used to access the part of a bitmap related to an individual cell.

Parameters:

Name	Type	Description
src	`Bitmap`	The bitmap
cell	`Integer`	The cell

Return Type: Rectangle

Signatures:

rectangle bitmap_rectangle_of_cell(bitmap src, int cell)

public Rectangle Bitmap.BitmapRectangleOfCell(int cell);
public static Rectangle SplashKit.BitmapRectangleOfCell(Bitmap src, int cell);

def bitmap_rectangle_of_cell(src, cell):

function BitmapRectangleOfCell(src: Bitmap; cell: Integer): Rectangle

Bitmap Set Cell Details

Initialise the bitmap cell details. This allows parts of the bitmap to be drawn as individual cells.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap
width	`Integer`	The width of each cell
height	`Integer`	The height of each cell
columns	`Integer`	The number of cell columns within the bitmap
rows	`Integer`	The number of cell rows within the bitmap
count	`Integer`	The total number of cells, may be fewer than columns * rows

Signatures:

void bitmap_set_cell_details(bitmap bmp, int width, int height, int columns, int rows, int count)

public void Bitmap.BitmapSetCellDetails(int width, int height, int columns, int rows, int count);
public static void SplashKit.BitmapSetCellDetails(Bitmap bmp, int width, int height, int columns, int rows, int count);

def bitmap_set_cell_details(bmp, width, height, columns, rows, count):

procedure BitmapSetCellDetails(bmp: Bitmap; width: Integer; height: Integer; columns: Integer; rows: Integer; count: Integer)

Bitmap Valid

Lets you test if bitmap value is valid. This will return true when it is a valid bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	the bitmap to test

Return Type: Boolean

Signatures:

bool bitmap_valid(bitmap bmp)

public static bool Images.BitmapValid(Bitmap bmp);
public static bool SplashKit.BitmapValid(Bitmap bmp);

def bitmap_valid(bmp):

function BitmapValid(bmp: Bitmap): Boolean

Bitmap Width

Returns the width of the bitmap.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap

Return Type: Integer

Signatures:

int bitmap_width(bitmap bmp)

public int Bitmap.Width { get }
public static int SplashKit.BitmapWidth(Bitmap bmp);

def bitmap_width(bmp):

function BitmapWidth(bmp: Bitmap): Integer

Bitmap Width

Returns the width of the bitmap.

Parameters:

Name	Type	Description
name	`String`	The name of the bitmap

Return Type: Integer

Signatures:

int bitmap_width(string name)

public static int Images.BitmapWidth(string name);
public static int SplashKit.BitmapWidth(string name);

def bitmap_width_of_bitmap_named(name):

function BitmapWidth(name: String): Integer

Clear Bitmap

Clear the bitmap to the indicated color. This will ensure the entire surface of the bitmap is set to that color.

Parameters:

Name	Type	Description
bmp	`Bitmap`	The bitmap
clr	`Color`	The new color for the surface of the bitmap

Signatures:

void clear_bitmap(bitmap bmp, color clr)

public void Bitmap.ClearBitmap(Color clr);
public static void SplashKit.ClearBitmap(Bitmap bmp, Color clr);

def clear_bitmap(bmp, clr):

procedure ClearBitmap(bmp: Bitmap; clr: Color)

Clear Bitmap

Clear the bitmap to the indicated color. This will ensure the entire surface of the bitmap is set to that color.

Parameters:

Name	Type	Description
name	`String`	The name of the bitmap
clr	`Color`	The new color for the surface of the bitmap

Signatures:

void clear_bitmap(string name, color clr)

public static void Images.ClearBitmap(string name, Color clr);
public static void SplashKit.ClearBitmap(string name, Color clr);

def clear_bitmap_named(name, clr):

procedure ClearBitmap(name: String; clr: Color)

Create Bitmap

Creates a new bitmap that you can draw to. Initially the bitmap will be transparent.

Parameters:

Name	Type	Description
name	`String`	The name of the bitmap resource to be created. If this already exists SplashKit will alter the name to make it unique.
width	`Integer`	The width of the created bitmap
height	`Integer`	The height of the created bitmap

Return Type: Bitmap

Signatures:

bitmap create_bitmap(string name, int width, int height)

public static Bitmap SplashKit.CreateBitmap(string name, int width, int height);
public Bitmap(string name, int width, int height);

def create_bitmap(name, width, height):

function CreateBitmap(name: String; width: Integer; height: Integer): Bitmap

Draw Bitmap

Draws the bitmap supplied into bmp to the current window. at x and y.

Parameters:

Name	Type	Description
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn

Signatures:

void draw_bitmap(bitmap bmp, double x, double y)

public void Bitmap.DrawBitmap(double x, double y);
public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y);

def draw_bitmap(bmp, x, y):

procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double)

Draw Bitmap

Draws the bitmap supplied into bmp to the current window. with extra drawing options supplied in opts at x and y.

Parameters:

Name	Type	Description
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn
opts	`Drawing Options`	the `Drawing Options` which provide extra information for how to draw the `Bitmap`

Signatures:

void draw_bitmap(bitmap bmp, double x, double y, drawing_options opts)

public void Bitmap.DrawBitmap(double x, double y, DrawingOptions opts);
public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y, DrawingOptions opts);

def draw_bitmap_with_options(bmp, x, y, opts):

procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)

Draw Bitmap

Searches and draws a bitmap with name name to the current window. with extra drawing options supplied in opts at x and y.

Parameters:

Name	Type	Description
name	`String`	the name of the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn

Signatures:

void draw_bitmap(string name, double x, double y)

public static void Images.DrawBitmap(string name, double x, double y);
public static void SplashKit.DrawBitmap(string name, double x, double y);

def draw_bitmap_named(name, x, y):

procedure DrawBitmap(name: String; x: Double; y: Double)

Draw Bitmap

Searches and draws a bitmap with name name to the current window. with extra drawing options supplied in opts at x and y.

Parameters:

Name	Type	Description
name	`String`	the name of the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn
opts	`Drawing Options`	the `Drawing Options` which provide extra information for how to draw the `Bitmap`

Signatures:

void draw_bitmap(string name, double x, double y, drawing_options opts)

public static void Images.DrawBitmap(string name, double x, double y, DrawingOptions opts);
public static void SplashKit.DrawBitmap(string name, double x, double y, DrawingOptions opts);

def draw_bitmap_named_with_options(name, x, y, opts):

procedure DrawBitmap(name: String; x: Double; y: Double; opts: DrawingOptions)

Draw Bitmap On Bitmap

Draws the bitmap supplied into bmp to the given bitmap. at x and y.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the bitmap to
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn

Signatures:

void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y)

public void Bitmap.DrawBitmapOnBitmap(Bitmap destination, double x, double y);
public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y);

def draw_bitmap_on_bitmap_on_bitmap(destination, bmp, x, y):

procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double)

Draw Bitmap On Bitmap

Draws the bitmap supplied into bmp to the given bitmap. with extra drawing options supplied in opts at x and y.

Parameters:

Name	Type	Description
destination	`Bitmap`	the bitmap to draw the bitmap to
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn
opts	`Drawing Options`	the `Drawing Options` which provide extra information for how to draw the `Bitmap`

Signatures:

void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y, drawing_options opts)

public void Bitmap.DrawBitmapOnBitmap(Bitmap destination, double x, double y, DrawingOptions opts);
public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y, DrawingOptions opts);

def draw_bitmap_on_bitmap_on_bitmap_with_options(destination, bmp, x, y, opts):

procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)

Draw Bitmap On Window

Draws the bitmap supplied into bmp to the given window. at x and y.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the bitmap to
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn

Signatures:

void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y)

public void Window.DrawBitmapOnWindow(Bitmap bmp, double x, double y);
public static void SplashKit.DrawBitmapOnWindow(Window destination, Bitmap bmp, double x, double y);

def draw_bitmap_on_window(destination, bmp, x, y):

procedure DrawBitmapOnWindow(destination: Window; bmp: Bitmap; x: Double; y: Double)

Draw Bitmap On Window

Draws the bitmap supplied into bmp to the given window. with extra drawing options supplied in opts at x and y.

Parameters:

Name	Type	Description
destination	`Window`	the window to draw the bitmap to
bmp	`Bitmap`	the bitmap which will be drawn to the screen
x	`Double`	the x location which represents where the bitmap will be drawn
y	`Double`	the y location which represents where the bitmap will be drawn
opts	`Drawing Options`	the `Drawing Options` which provide extra information for how to draw the `Bitmap`

Signatures:

void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y, drawing_options opts)

public void