SHIP:Port:glass

From Serious Documentation
Jump to: navigation, search

Glass ports are used to control the display of the SIM and are usually referred to in the format "platform.GLASS0", "platform.GLASS1", etc.

The various fields are populated at SHIPEngine launch with the defaults for the given platform.

Portvar Data Type Permissions Description
kick Boolean Read/Write Toggling the value of kick resets the backlight timer (if set). The actual value is irrelevant; it is the change event that resets the backlight timer. As such, kick should always be assigned to the opposite of its current value (i.e. GLASS0.kick = !GLASS0.kick).
timeout Integer Read/Write The number of seconds until the backlight shuts off automatically. If kick is changed, the timer is reset to the full timeout value. If set to 0, the backlight will never shut off automatically. This value is always 0 (disabled) at boot. If a default value other than 0 is desired, store the desired value in a persistent variable in your GUI and load it into timeout at boot time using the shiplaunch event.
width Dimension Read Only This is the width (x), in pixels, of the SIM's display. (Default: platform specific)
height Dimension Read Only This is the height (y), in pixels, of the SIM's display. (Default: platform specific)
mirrorx Boolean Read/Write When set, the entire display is mirrored in the x direction. Can be used in conjunction with flipxy. (Default false)
mirrory Boolean Read/Write When set, the entire display is mirrored in the y direction. Can be used in conjunction with flipxy. (Defaultfalse)
flipxy Boolean Read/Write When set, the entire display is flipped on the x-y axis (portrait mode). Can be used in conjunction with mirrorx and/or mirrory. (Default: false)
bpp Byte Read Only Number of bits per pixel on the glass. The total number of displayable colors is 2 to the power of this number (e.g. 2^16 = 65536 total colors). (Default: platform specific)
backlight Byte Read/Write The brightness of the backlight between 0 (off) and 100 (max). Regulating backlight intensity can decrease power, increase longevity of the backlight hardware, and improve viewing in different lighting conditions. Setting this to an out of range value sets the backlight to max. (Default: 100)

see GRM