Graphics
Functions
Draw Circle
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
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
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
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
Draw Circle On Bitmap
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
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
Draw Circle On Window
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
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
Fill Circle
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
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
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
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
Fill Circle On Bitmap
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
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
Fill Circle On Window
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
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
Current Clip
Current Clip
Returns the rectangle of the current clip area for the current window
Return Type - Rectangle
Signatures
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
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
Pop Clip
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
Pop Clip
Remove the last clipping rectangle pushed to the current window. This will then apply the previously pushed clipping rectangle.
Signatures
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
Push Clip
Push Clip
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
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
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
Reset Clip
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
Reset Clip
Reset the clipping rectangle of the current window. This will clear all of the clipping rectangles pushed to the current window.
Signatures
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
Set Clip
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
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
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
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
Option Draw To
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
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
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
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
Option Flip X
Option Flip X
Use this option to flip an image along its X axis.
Return Type - Drawing Options
Signatures
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
Option Flip Xy
Option Flip Xy
Use this option to flip the drawing of an image along both X and Y axis.
Return Type - Drawing Options
Signatures
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
Option Flip Y
Option Flip Y
Use this option to flip the drawing of an image along its Y axis.
Return Type - Drawing Options
Signatures
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
Option Line Width
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
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
Option Part Bmp
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
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
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
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
Option Rotate Bmp
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
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
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
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
Option Scale Bmp
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
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
Option To Screen
Option To Screen
Use this option to draw to the screen, ignoring the positon of the camera.
Return Type - Drawing Options
Signatures
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
Option To World
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
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
Option With Animation
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
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
Option With Bitmap Cell
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
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. This extends
the passed in drawing options with the cell details.
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
Draw Ellipse
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
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
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
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
Draw Ellipse On Bitmap
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
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
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
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
Draw Ellipse On Window
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
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
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
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
Fill Ellipse
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
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
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
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
Fill Ellipse On Bitmap
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
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
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
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
Fill Ellipse On Window
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
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
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
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
Clear Screen
Clear Screen
Clears the current screen to color white.
Signatures
Clear Screen
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color to clear the screenβs background color to. |
Signatures
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 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
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
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
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
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
Number Of Displays
Returns the number of physical displays attached to the computer.
Return Type - Integer
Signatures
Refresh Screen
Refresh Screen
Signatures
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
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
Screen Height
Returns the height of the current window.
Return Type - Integer
Signatures
Screen Width
Returns the width of the current window.
Return Type - Integer
Signatures
Take Screenshot
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
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
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
Bitmap Bounding Rectangle
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
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
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
Bitmap Cell 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. |
x | Double | The the x location of the bitmap. |
y | Double | The the y location of the bitmap. |
Return Type - Circle
Signatures
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
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
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
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
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
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
Bitmap Cell Rectangle
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
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
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
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
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
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
Bitmap Height
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
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
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
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 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
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
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
Bitmap Width
Bitmap Width
Returns the width of the bitmap.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap |
Return Type - Integer
Signatures
Bitmap Width
Returns the width of the bitmap.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the bitmap |
Return Type - Integer
Signatures
Clear Bitmap
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
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
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
Draw 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
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
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
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
Draw Bitmap On Bitmap
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
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
Draw Bitmap On Window
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
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
Free All Bitmaps
Free all of the loaded bitmap resources.
Signatures
Free Bitmap
Frees the bitmap resource.
Parameters
Name | Type | Description |
---|---|---|
to_delete | Bitmap | The bitmap to be freed. |
Signatures
Has Bitmap
Determines if SplashKit has a bitmap loaded for the supplied name. This checks against all bitmaps loaded.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name to check |
Return Type - Boolean
Signatures
Load Bitmap
Loads and returns a bitmap. The supplied filename
is used to
locate the Bitmap to load. The supplied name
indicates the
name to use to refer to this Bitmap in SplashKit. The Bitmap
can then
be retrieved by passing this name
to the Bitmap Named
function.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the bitmap resource in SplashKit |
filename | String | The filename to load |
Return Type - Bitmap
Signatures
Pixel Drawn At Point
Pixel Drawn At Point
Check if the bitmap has a pixel drawn at the indicated point.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to check. |
pt | Point 2d | The point within the bitmap to check. |
Return Type - Boolean
Signatures
Pixel Drawn At Point
Check if the bitmap has a pixel drawn at the indicated point.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to check. |
x | Double | The x coordinate within the bitmap to check |
y | Double | The y coordinate within the bitmap to check |
Return Type - Boolean
Signatures
Pixel Drawn At Point
Check if the bitmap has a pixel drawn at the indicated point in the cell.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to check. |
cell | Integer | The bitmap cell to check. |
pt | Point 2d | The point within the bitmap to check. |
Return Type - Boolean
Signatures
Pixel Drawn At Point
Check if the bitmap has a pixel drawn at the indicated point in the cell.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to check. |
cell | Integer | The bitmap cell to check. |
x | Double | The x coordinate within the bitmap to check |
y | Double | The y coordinate within the bitmap to check |
Return Type - Boolean
Signatures
Setup Collision Mask
Sets up the collision mask for a bitmap. This enables collision detection between this bitmap and other bitmaps or shapes.
This is automatically called when a bitmap is loaded, and only needs to be
called on bitmaps created using Create Bitmap
, and when a bitmap is
changed by drawing onto the bitmap.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | the bitmap to setup |
Signatures
Draw Line
Draw Line
Draws a line onto the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
l | Line | The lineβs details |
Signatures
Draw Line
Draws a line.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
l | Line | The lineβs details |
opts | Drawing Options | The drawing options |
Signatures
Draw Line
Draw a line from one point to another on the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
Signatures
Draw Line
Draw a line from one point to another on the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
opts | Drawing Options | The drawing options |
Signatures
Draw Line
Draw a line from one point to another on the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
x1 | Double | The distance from the left of the window/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the window/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the window/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the window/bitmap to the second |
point |
Signatures
Draw Line
Draw a line from one point to another
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the line |
x1 | Double | The distance from the left of the window/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the window/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the window/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the window/bitmap to the second |
point | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Bitmap
Draw Line On Bitmap
Draws a line onto the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
l | Line | The lineβs details |
Signatures
Draw Line On Bitmap
Draws a line on the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
l | Line | The lineβs details |
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Bitmap
Draw a line from one point to another on the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
Signatures
Draw Line On Bitmap
Draw a line from one point to another on the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Bitmap
Draw a line from one point to another on the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
x1 | Double | The distance from the left of the bitmap/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the bitmap/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the bitmap/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the bitmap/bitmap to the second |
point |
Signatures
Draw Line On Bitmap
Draw a line from one point to another
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the line |
x1 | Double | The distance from the left of the bitmap/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the bitmap/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the bitmap/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the bitmap/bitmap to the second |
point | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Window
Draw Line On Window
Draws a line onto the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
l | Line | The lineβs details |
Signatures
Draw Line On Window
Draws a line on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
l | Line | The lineβs details |
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Window
Draw a line from one point to another on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
Signatures
Draw Line On Window
Draw a line from one point to another on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
from_pt | Point 2d | The start of the line |
to_pt | Point 2d | The end of the line |
opts | Drawing Options | The drawing options |
Signatures
Draw Line On Window
Draw a line from one point to another on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
x1 | Double | The distance from the left of the window/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the window/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the window/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the window/bitmap to the second |
point |
Signatures
Draw Line On Window
Draw a line from one point to another
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination bitmap |
clr | Color | The color of the line |
x1 | Double | The distance from the left of the window/bitmap to the first |
point | ||
y1 | Double | The distance from the top of the window/bitmap to the first |
point | ||
x2 | Double | The distance from the left of the window/bitmap to the second |
point | ||
y2 | Double | The distance from the top of the window/bitmap to the second |
point | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel
Draw Pixel
Draws an individual pixel to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
Signatures
Draw Pixel
Draws an individual pixel with the supplied options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel
Draws an individual pixel to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the window to the |
pixel | ||
y | Double | The distance from the top edge of the window to the |
pixel |
Signatures
Draw Pixel
Draws an individual pixel with the supplied options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the window/bitmap to the |
pixel | ||
y | Double | The distance from the top edge of the window/bitmap to the |
pixel | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel On Bitmap
Draw Pixel On Bitmap
Draws an individual pixel to the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | the bitmap to draw the pixel on |
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
Signatures
Draw Pixel On Bitmap
Draws an individual pixel to the given bitmap with the given drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | the bitmap to draw the pixel on |
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel On Bitmap
Draws an individual pixel to the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | the bitmap to draw the pixel on |
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the bitmap to the |
pixel | ||
y | Double | The distance from the top edge of the bitmap to the |
pixel |
Signatures
Draw Pixel On Bitmap
Draws an individual pixel to the given bitmap with the given drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | the bitmap to draw the pixel on |
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the bitmap to the |
pixel | ||
y | Double | The distance from the top edge of the bitmap to the |
pixel | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel On Window
Draw Pixel On Window
Draws an individual pixel to the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window to draw the pixel on |
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
Signatures
Draw Pixel On Window
Draws an individual pixel to the given window with the given drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window to draw the pixel on |
clr | Color | The color of the pixel |
pt | Point 2d | The location of the pixel to draw |
opts | Drawing Options | The drawing options |
Signatures
Draw Pixel On Window
Draws an individual pixel to the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | the window to draw the pixel on |
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the window to the |
pixel | ||
y | Double | The distance from the top edge of the window to the |
pixel |
Signatures
Draw Pixel On Window
Draws an individual pixel to the given window with the given drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window to draw the pixel on |
clr | Color | The color of the pixel |
x | Double | The distance from the left edge of the window to the |
pixel | ||
y | Double | The distance from the top edge of the window to the |
pixel | ||
opts | Drawing Options | The drawing options |
Signatures
Get Pixel
Get Pixel
Returns the color of the pixel at the location on the supplied bitmap.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to get the color from |
pt | Point 2d | The position of the pixel |
Return Type - Color
Signatures
Get Pixel
Returns the color of the pixel at the x,y location on the supplied bitmap.
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to get the color from |
x | Double | The distance from the left edge of the bitmap to the pixel |
to read | ||
y | Double | The distance from the top of the bitmap to the pixel to read |
Return Type - Color
Signatures
Get Pixel
Returns the color of the pixel at the x,y location on the current window.
Parameters
Name | Type | Description |
---|---|---|
pt | Point 2d | The position of the pixel |
Return Type - Color
Signatures
Get Pixel
Returns the color of the pixel at the x,y location on the current window.
Parameters
Name | Type | Description |
---|---|---|
x | Double | The distance from the left edge of the window to the pixel |
to read | ||
y | Double | The distance from the top of the window to the pixel to read |
Return Type - Color
Signatures
Get Pixel
Returns the color of the pixel at the location on the supplied window.
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to get the color from |
pt | Point 2d | The position of the pixel |
Return Type - Color
Signatures
Get Pixel
Returns the color of the pixel at the x,y location on the supplied window.
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to get the color from |
x | Double | The distance from the left edge of the window to the pixel |
to read | ||
y | Double | The distance from the top of the window to the pixel to read |
Return Type - Color
Signatures
Get Pixel From Window
Get Pixel From Window
Returns the color of the pixel at the x,y location on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window to draw the pixel on |
pt | Point 2d | The position of the pixel |
Return Type - Color
Signatures
Get Pixel From Window
Returns the color of the pixel at the x,y location on the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window to draw the pixel on |
x | Double | The distance from the left edge of the window to the pixel |
to read | ||
y | Double | The distance from the top of the window to the pixel to read |
Return Type - Color
Signatures
Draw Quad
Draw Quad
Draw a quad to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Draw Quad
Draw a quad using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Draw Quad On Bitmap
Draw Quad On Bitmap
Draw a quad on the supplied bitmap to the current bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Draw Quad On Bitmap
Draw a quad on the supplied bitmap using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Draw Quad On Window
Draw Quad On Window
Draw a quad on the supplied window to the current window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Draw Quad On Window
Draw a quad on the supplied window using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Draw Rectangle
Draw Rectangle
Draw a rectangle onto the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
Signatures
Draw Rectangle
Draw a rectangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
opts | Drawing Options | The drawing options |
Signatures
Draw Rectangle
Draw a rectangle to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Draw Rectangle
Draw a rectangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | The drawing options |
Signatures
Draw Rectangle On Bitmap
Draw Rectangle On Bitmap
Draw a rectangle to the bitmap using the supplied rect. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
rect | Rectangle | the rectangle to be drawn to the bitmap |
Signatures
Draw Rectangle On Bitmap
Draw a rectangle to the bitmap using the supplied rect and drawing options. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
rect | Rectangle | the rectangle to be drawn to the bitmap |
opts | Drawing Options | Drawing options to configure the drawing operation |
Signatures
Draw Rectangle On Bitmap
Draw a rectangle to the bitmap using. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
x | Double | The x location of the rectangle |
y | Double | The y location of the rectangle |
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Draw Rectangle On Bitmap
Draw a rectangle to the bitmap using the supplied drawing options. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
x | Double | The x location of the rectangle |
y | Double | The y location of the rectangle |
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | Drawing options to configure the drawing operation |
Signatures
Draw Rectangle On Window
Draw Rectangle On Window
Draw a rectangle to the window using the supplied rect. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
rect | Rectangle | the rectangle to be drawn to the window |
Signatures
Draw Rectangle On Window
Draw a rectangle to the window using the supplied rect and drawing options. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
rect | Rectangle | the rectangle to be drawn to the window |
opts | Drawing Options | Drawing options to configure the drawing operation |
Signatures
Draw Rectangle On Window
Draw a rectangle to the window using. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
x | Double | The x location of the rectangle |
y | Double | The y location of the rectangle |
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Draw Rectangle On Window
Draw a rectangle to the window using the supplied drawing options. The rectangle is centred on its x, y coordinates, and has the provided width and height.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
x | Double | The x location of the rectangle |
y | Double | The y location of the rectangle |
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | Drawing options to configure the drawing operation |
Signatures
Fill Quad
Fill Quad
Fill a quad on the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Fill Quad
Fill a quad using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Fill Quad On Bitmap
Fill Quad On Bitmap
Fill a quad on the supplied bitmap on the current bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Fill Quad On Bitmap
Fill a quad on the supplied bitmap using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Fill Quad On Window
Fill Quad On Window
Fill a quad on the supplied window on the current window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
Signatures
Fill Quad On Window
Fill a quad on the supplied window using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color for the quad |
q | Quad | The details of the quad |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle
Fill Rectangle
Fill a rectangle onto the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
Signatures
Fill Rectangle
Fills a rectangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle
Fills a rectangle to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Fill Rectangle
Fills a rectangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle On Bitmap
Fill Rectangle On Bitmap
Fill a rectangle on the supplied bitmap onto the current bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
Signatures
Fill Rectangle On Bitmap
Fills a rectangle on the supplied bitmap using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle On Bitmap
Fills a rectangle on the supplied bitmap to the current bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the bitmap/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the bitmap/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Fill Rectangle On Bitmap
Fills a rectangle on the supplied bitmap, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The destination bitmap |
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the bitmap/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the bitmap/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle On Window
Fill Rectangle On Window
Fill a rectangle on the supplied window onto the current window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
Signatures
Fill Rectangle On Window
Fills a rectangle on the supplied window using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
rect | Rectangle | The rectangle to draw |
opts | Drawing Options | The drawing options |
Signatures
Fill Rectangle On Window
Fills a rectangle on the supplied window to the current window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
Signatures
Fill Rectangle On Window
Fills a rectangle on the supplied window, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The destination window |
clr | Color | The color of the rectangle |
x | Double | The distance from the left of the window/bitmap to the |
rectangle | ||
y | Double | The distance from the top of the window/bitmap to the |
rectangle | ||
width | Double | The width of the rectangle |
height | Double | The height of the rectangle |
opts | Drawing Options | The drawing options |
Signatures
Draw Text
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The desired size of the font. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Bitmap
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Bitmap
Parameters
Name | Type | Description |
---|---|---|
bmp | Bitmap | The bitmap to draw to |
text | String | The text string to be written to the bitmap. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The desired size of the font. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Window
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | String | The name of the Font which will be used to draw the text |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The size of the font which will be drawn. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
Signatures
Draw Text On Window
Parameters
Name | Type | Description |
---|---|---|
wnd | Window | The window to draw to |
text | String | The text string to be written to the window. |
clr | Color | The desired Color of the text to be written. |
fnt | Font | The Font to be used to draw the text. |
font_size | Integer | The desired size of the font. |
x | Double | The x location to draw the text. |
y | Double | The y location to draw the text. |
opts | Drawing Options | The Drawing Options which provide extra information for how to draw the text. |
Signatures
Font Has Size
Font Has Size
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the Font to be checked. |
font_size | Integer | The size to check. |
Return Type - Boolean
Signatures
Font Has Size
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The Font to be checked. |
font_size | Integer | The size to check. |
Return Type - Boolean
Signatures
Font Load Size
Font Load Size
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the Font to load the size for. |
font_size | Integer | The desired size of the Font . |
Signatures
Font Load Size
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The Font to load the size for. |
font_size | Integer | The desired size of the Font . |
Signatures
Font Named
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the font to find. |
Return Type - Font
Signatures
Free All Fonts
Signatures
Free Font
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The font to be freed. |
Signatures
Get Font Style
Get Font Style
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the font to return the style of. |
Return Type - Font Style
Signatures
Get Font Style
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The Font to return the style of. |
Return Type - Font Style
Signatures
Has Font
Has Font
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The Font to check if loaded. |
Return Type - Boolean
Signatures
Has Font
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of Font to check if loaded. |
Return Type - Boolean
Signatures
Load Font
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the Font to be loaded from file. |
filename | String | The name of the file to load the Font from. |
Return Type - Font
Signatures
Set Font Style
Set Font Style
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the Font to set the style of. |
style | Font Style | The new style for the Font . |
Signatures
Set Font Style
Parameters
Name | Type | Description |
---|---|---|
fnt | Font | The Font to set the style of. |
style | Font Style | The new style for the Font . |
Signatures
Text Height
Text Height
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to check the length of. |
fnt | String | The font used for the text. |
font_size | Integer | The size of the font used for the text. |
Return Type - Integer
Signatures
Text Height
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to check the length of. |
fnt | Font | The font used for the text. |
font_size | Integer | The size of the font used for the text. |
Return Type - Integer
Signatures
Text Width
Text Width
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to check the length of. |
fnt | String | The font used for the text. |
font_size | Integer | The size of the font used for the text. |
Return Type - Integer
Signatures
Text Width
Parameters
Name | Type | Description |
---|---|---|
text | String | The text string to check the length of. |
fnt | Font | The font used for the text. |
font_size | Integer | The size of the font used for the text. |
Return Type - Integer
Signatures
Draw Triangle
Draw Triangle
Draw a triangle onto the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Draw Triangle
Draw a triangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Draw Triangle
Draw a triangle to the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the window to the |
third point of the triangle |
Signatures
Draw Triangle
Draw a triangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/window to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Triangle On Bitmap
Draw Triangle On Bitmap
Draw a triangle on a given bitmap, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Draw Triangle On Bitmap
Draw a triangle on a given bitmap, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Draw Triangle On Bitmap
Draw a triangle to the given bitmap.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap to the |
third point of the triangle |
Signatures
Draw Triangle On Bitmap
Draw a triangle to the given bitmap, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/bitmap to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/bitmap to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/bitmap to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/bitmap to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/bitmap to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/bitmap to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures
Draw Triangle On Window
Draw Triangle On Window
Draw a triangle on a given window, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Draw Triangle On Window
Draw a triangle on a given window, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Draw Triangle On Window
Draw a triangle to the given window.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the window to the |
third point of the triangle |
Signatures
Draw Triangle On Window
Draw a triangle to the given window, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/window to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle
Fill Triangle
Draw a triangle onto the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Fill Triangle
Fill a triangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle
Fills a triangle on the current window.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the window to the |
third point of the triangle |
Signatures
Fill Triangle
Fills a triangle using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/window to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle On Bitmap
Fill Triangle On Bitmap
Fill a triangle on a given bitmap
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Fill Triangle On Bitmap
Fill a triangle on a given bitmap, using given drawing options
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle On Bitmap
Fill a triangle on a given bitmap
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap to the |
third point of the triangle |
Signatures
Fill Triangle On Bitmap
Fill a triangle on a given bitmap, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Bitmap | The bitmap which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/bitmap to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/bitmap to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/bitmap to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/bitmap to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/bitmap to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/bitmap to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle On Window
Fill Triangle On Window
Fill a triangle on a given window
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
Signatures
Fill Triangle On Window
Fill a triangle on a given window, using given drawing options
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
tri | Triangle | The triangles details |
opts | Drawing Options | The drawing options |
Signatures
Fill Triangle On Window
Fill a triangle on a given window
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the window to the |
third point of the triangle |
Signatures
Fill Triangle On Window
Fill a triangle on a given window, using the supplied drawing options.
Parameters
Name | Type | Description |
---|---|---|
destination | Window | The window which the triangle will be drawn on. |
clr | Color | The color for the triangle |
x1 | Double | The distance from the left side of the bitmap/window to the |
first point of the triangle | ||
y1 | Double | The distance from the top of the bitmap/window to the |
first point of the triangle | ||
x2 | Double | The distance from the left side of the bitmap/window to the |
second point of the triangle | ||
y2 | Double | The distance from the top of the bitmap/window to the |
second point of the triangle | ||
x3 | Double | The distance from the left side of the bitmap/window to the |
third point of the triangle | ||
y3 | Double | The distance from the top of the bitmap/window to the |
third point of the triangle | ||
opts | Drawing Options | The drawing options |
Signatures