Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Display Info | |Name=Display Info | ||
}} | }} | ||
The '''DisplayInfo''' component is used to get information about the local user's display. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|DisplayIndex|Int| | |DisplayIndex|Int| The display index to get info on. | ||
|Resolution|{{RootFieldType|RawOutput`1|[[Type:Int2|Int2]]}}|TypeAdv1=true| | |Resolution|{{RootFieldType|RawOutput`1|[[Type:Int2|Int2]]}}|TypeAdv1=true| The resolution of display <code>DisplayIndex</code> | ||
|Offset|{{RootFieldType|RawOutput`1|[[Type:Int2|Int2]]}}|TypeAdv2=true| | |Offset|{{RootFieldType|RawOutput`1|[[Type:Int2|Int2]]}}|TypeAdv2=true| The offset of pixels of display <code>DisplayIndex</code> | ||
|DPI|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv3=true| | |DPI|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv3=true| The Dots Per Inch of display <code>DisplayIndex</code> | ||
|RefreshRate|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv4=true| | |RefreshRate|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv4=true| The refresh rate in Hertz of <code>DisplayIndex</code> | ||
|Orientation|{{RootFieldType|RawOutput`1|[[Type:RectOrientation|RectOrientation]]}}|TypeAdv5=true| | |Orientation|{{RootFieldType|RawOutput`1|[[Type:RectOrientation|RectOrientation]]}}|TypeAdv5=true| The orientation of <code>DisplayIndex</code>. | ||
|IsPrimary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true| | |IsPrimary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true| Whether display <code>DisplayIndex</code> is the main monitor in the OS. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
| Line 24: | Line 24: | ||
[[Category:Components:Input:Desktop{{#translation:}}|Display Info]] | [[Category:Components:Input:Desktop{{#translation:}}|Display Info]] | ||
[[Category:Components{{#translation:}}|Display Info]] | [[Category:Components{{#translation:}}|Display Info]] | ||
Latest revision as of 18:31, 22 December 2024
Component image 
Display Info component as seen in the Scene Inspector
The DisplayInfo component is used to get information about the local user's display.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
DisplayIndex
|
Int | The display index to get info on. |
Resolution
|
raw output of Int2 | The resolution of display DisplayIndex
|
Offset
|
raw output of Int2 | The offset of pixels of display DisplayIndex
|
DPI
|
raw output of Float2 | The Dots Per Inch of display DisplayIndex
|
RefreshRate
|
raw output of Double | The refresh rate in Hertz of DisplayIndex
|
Orientation
|
raw output of RectOrientation | The orientation of DisplayIndex.
|
IsPrimary
|
raw output of Bool | Whether display DisplayIndex is the main monitor in the OS.
|