Name
BACKFILL -- configure backfill settings for script (V4.5)
Synopsis
@BACKFILL table
Function
Important note: This preprocessor command is deprecated since Hollywood 6.0. As Hollywood 6.0 introduced support for multiple monitors, there could also be multiple backfills (one for every display as displays could be on separate monitors). That is why backfills should be set up using the @DISPLAY preprocessor command or the CreateDisplay() function now. You can still use this preprocessor command but it will affect the first display only.

This preprocessor command can be used to configure the backfill settings for your script. Backfills can be used to create a shielding window that covers the whole area not occupied by your main display. You can use a static color as a backfill, a gradient, an image, or a texture. Before Hollywood 4.5, backfills were configured using the @DISPLAY preprocessor command. Hollywood 4.5, however, introduced multiple displays which made it necessary to move the backfill settings into its own preprocessor command because there can be only a single backfill per script.

You have to pass a table to this command. The following table tags are currently recognized:

Type:
This field is obligatory. It can be Color, Gradient, Texture or Picture. The type must be passed as a string here.

Color:
If you've specified Color as backfill type, pass the desired backfill color in this field.

StartColor, EndColor:
If you've specified Gradient as backfill type, use these two fields to define the start and end colors for the gradient.

Brush:
If you've specified Texture or Picture as backfill type, specify the identifier of the brush to use as the source image here. If you want to pass the file name directly, use the BrushFile tag instead.

X,Y:
If you've specified Picture as backfill type, you can use these two fields to position the picture on the screen. They both default to #CENTER.

BrushFile:
If you've specified Texture or Picture as backfill type, you can specify the file name of the brush to use as the source image here. The file specified here will be linked to the applet/executable on compilation unless you set LinkBrushFile to False. If you want to pass a brush identifier, use the Brush tag instead. (V4.0)

LinkBrushFile:
If BrushFile has been specified this tag can be used to declare whether or not the brush file shall be linked into the applet/executable on compilation. Defaults to True which means that the brush file will be linked. (V4.0)

Transparency:
If backfill type is Picture you can specify an RGB color here that shall be shown transparently. Defaults to #NOTRANSPARENCY. (V4.0)

ScalePicture:
If backfill type is Picture you can use this tag to define whether or not the picture shall be scaled to fit the backfill window's dimensions. Defaults to False. (V4.0)

SmoothScale:
Set this tag to True if you want to have interpolated scaling of the picture that should be used as a backfill image. This tag is only handled if ScalePicture has been set to True. Defaults to False. (V6.0)

Alternatively, backfill settings can also be configured from the command line. If you want to disable that, you should compile your scripts using the -locksettings console argument.

You might also want to specify the HideTitleBar tag in @SCREEN. If you specify HideTitleBar, the backfill will also shield the current screen's title bar (Amiga) or Finder's menu bar (macOS).

Inputs
table
table declaring the style of the script's backfill
Example
@BACKFILL {Type = "Gradient", StartColor = #BLACK, EndColor = #BLUE}
This declaration will install a gradient from black to blue as the backfill.

Show TOC