Difference between revisions of "SHIP:Port:glass"

From Serious Documentation
Jump to: navigation, search
Line 4: Line 4:
  
 
{{PortvarTableStart|}}
 
{{PortvarTableStart|}}
−
|<onlyinclude>{{Portvar|glass|kick}}||{{DataType|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. <code>GLASS0.kick = !GLASS0.kick</code>).
+
|{{Portvar|glass|kick}}||{{DataType|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. <code>GLASS0.kick = !GLASS0.kick</code>).
 
|-
 
|-
 
||{{Portvar|glass|timeout}}||{{DataType|Integer}}||Read/Write||Sets the number of seconds until the backlight shuts off automatically. If {{Portvar|glass|kick}} is changed, the timer is reset to the full timeout value. If set to <code>0</code>, the backlight will never shut off automatically. This value is always <code>0</code> (disabled) at boot. If a default value other than <code>0</code> is desired, store the desired value in a persistent variable in your GUI and load it into '''timeout''' on boot using the {{SysVar|shiplaunch}} event.
 
||{{Portvar|glass|timeout}}||{{DataType|Integer}}||Read/Write||Sets the number of seconds until the backlight shuts off automatically. If {{Portvar|glass|kick}} is changed, the timer is reset to the full timeout value. If set to <code>0</code>, the backlight will never shut off automatically. This value is always <code>0</code> (disabled) at boot. If a default value other than <code>0</code> is desired, store the desired value in a persistent variable in your GUI and load it into '''timeout''' on boot using the {{SysVar|shiplaunch}} event.
Line 20: Line 20:
 
||{{Portvar|glass|bpp}} (see [[GRMs|GRM]])||{{DataType|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)
 
||{{Portvar|glass|bpp}} (see [[GRMs|GRM]])||{{DataType|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)
 
|-
 
|-
−
||{{Portvar|glass|backlight}}||{{DataType|Byte}}||Read/Write||A percentage of backlight brightness between <code>0</code> (off) and <code>100</code> (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 100%. (Default: <code>100</code>)</onlyinclude>
+
||{{Portvar|glass|backlight}}||{{DataType|Byte}}||Read/Write||A percentage of backlight brightness between <code>0</code> (off) and <code>100</code> (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 100%. (Default: <code>100</code>)
 
|}
 
|}

Revision as of 17:49, 31 January 2013

describe glass port

ToDo


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 Sets 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 on boot using the shiplaunch event.
width (see GRM) Dimension Read Only This is the width (x), in pixels, of the SIM's display. (Default: platform specific)
height (see GRM) 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. (Default false)
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 (see GRM) 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 A percentage of backlight brightness 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 100%. (Default: 100)
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Port:glass&oldid=2629"