Name
DisplayBGPic -- change the background picture
Synopsis
DisplayBGPic(id[, args])
Function
This function changes the background picture to the one specified by id. If the dimensions of this picture differ from the current one, the display size will be adjusted.

New in Hollywood 4.0: You can pass a table in the optional second argument to specify further options. Currently, the table can contain the following fields:

X:
Specifies the new x position for the display. If you want the display to keep its current x position, specify the special constant #KEEPPOSITION. Defaults to #CENTER.

Y:
Specifies the new y position for the display. If you want the display to keep its current y position, specify the special constant #KEEPPOSITION. Defaults to #CENTER.

Inputs
id
identifier of the background picture to display
args
optional: specifies further configuration options (V4.0)
Example
DisplayBGPic(2)
Displays background picture 2 and adjusts the window size if necessary.


DisplayBGPic(2, {X = #RIGHT, Y = #BOTTOM})
Displays background picture at the bottom-right of the current desktop.

Show TOC