Name
OpenDisplay -- open a display (V4.5)
Synopsis
OpenDisplay(id[, table])
Function
This function will open a display previously created using CreateDisplay() and make it visible. Starting with Hollywood 6.0 this function accepts an optional table argument which can be used to configure some advanced options. The following tags are currently recognized by the optional table argument:

Mode:
This tag allows you to specify the mode the display should be opened in. You have to pass one of the following strings to this tag:

Windowed
Open display in windowed mode.

FullScreen
Open in full screen mode. This can change your monitor's resolution to the dimensions which fit best to your display's dimensions. If you don't want that, take a look at the FullScreenScale and FakeFullScreen modes below.

FullScreenScale
This is a special full screen mode which won't change your monitor's resolution. Instead, Hollywood's display will be resized to fit your monitor's dimensions. Additionally, this full screen mode will activate the auto scaling engine so that your display is automatically scaled to fit your monitor's dimensions. FullScreenScale will use auto scaling by default. If you would like it to use layer scaling, you have to set ScaleMode to #SCALEMODE_LAYER as well. FullScreenScale is especially useful on mobile devices whose display hardware has a hard-coded resolution and doesn't support resolution changes in the same way as an external monitor connected to a desktop computer does. The downside of FullScreenScale is that it is slower because Hollywood has to scale all rendering operations to the monitor's dimensions. (V7.0)

FakeFullScreen
Open in fake full screen mode. This means that Hollywood will not change the monitor's resolution but the backfill window will be configured to shield the desktop completely. Thus, the user gets the impression as if Hollywood was running full screen, although it is running on the desktop.

ModeRequester
This will open a display mode requester allowing the user to choose the desired full screen mode for this display.

Ask
This will open a requester asking the user to choose between windowed and full screen mode.

By default, OpenDisplay() will use the mode that was specified when creating the display.

ScrWidth, ScrHeight:
If Mode has been set to FullScreen, these tags allow you to set the desired dimensions for the full screen mode. Defaults to what has been set when creating the display. Starting with Hollywood 7.0 you can also set these tags to the special constant #NATIVE. In that case, Hollywood will use the dimensions of the display's host device.

ScrDepth:
If Mode has been set to FullScreen, this tag allows you to set the desired depth for the full screen mode. Defaults to what has been set when creating the display.

Backfill:
This tag allows you to configure the backfill setting for this display. The table you have to specify here has to follow the same conventions as its counterpart that can be passed to the Backfill tag of the @DISPLAY preprocessor command. See DISPLAY for details.

NoSelect:
This tag allows you to specify whether or not the newly opened display shall be selected as the current output device. NoSelect defaults to False which means that by default, OpenDisplay() will open the specified display and select it as the current output device. If you do not want this behaviour, pass True in NoSelect. In that case, you need to manually call SelectDisplay() before you can draw into the display.

Monitor:
This tag allows you to specify the monitor this display should be opened on. Monitors are counted from 1 to the number of monitors available to the system. Please note that if you set this tag, functions that accept display coordinates, e.g. MoveDisplay(), will interpret them as values relative to the origin of the monitor specified in the Monitor tag. This tag defaults to what has been set when creating the display.

XServer:
This tag can be used to specify the X Server that should open this display. By default, Hollywood will use the X Server that has been specified when creating the display. This tag is only available in the Linux version of Hollywood.

PubScreen:
This tag can be used to specify the public screen this display should be opened on. You have to pass a string that contains the name of the public screen to use here. By default, Hollywood will use the public screen specified when creating the display. This tag is only supported on AmigaOS compatible operating systems.

ScreenName:
If this display is to be opened in full screen mode, you can set the desired public screen name of the display's own screen with this tag. By default, Hollywood will use the screen name specified when creating the display. This tag is only available in the AmigaOS compatible versions of Hollywood.

Inputs
id
identifier of the display to open
table
optional: table argument containing further options (see above) (V6.0)
Example
See CreateDisplay


Show TOC