Img add fullscreen

From Sim Innovations Wiki
Jump to navigation Jump to search

Description

image_id = img_add_fullscreen(filename)
image_id = img_add_fullscreen(filename, style)

img_add_fullscreen is used to show an image fullscreen on the canvas. The image is also stored in memory for further references.

Return value

Argument Type Description
image_id ID This value can be used for further reference. Functions such as move and img_rotate can use this image_id. Its good practice to store this image_id in your logic code.

Arguments

# Argument Type Description
1 filename String This is the filename of the image you would like to show. Note that this is both filename and extension. Its good practice to always the PNG format for images. JPG and BMP are also supported, but not recommended.
2 style String (Optional) The style to use. See img_add for available style arguments.

Example

-- Load and display text and images
myimage1 = img_add_fullscreen("myimage1.png")

-- Note that myimage2 is placed on top of image1. Off course, transparency is supported.
myimage2 = img_add_fullscreen("myimage2.png")