Component:DesktopRenderSettings: Difference between revisions
From Resonite Wiki
More actions
989onan bot (talk | contribs) Automated: update Categories, SyncDelegates |
add info |
||
| Line 3: | Line 3: | ||
|Name=Desktop Render Settings | |Name=Desktop Render Settings | ||
}} | }} | ||
The '''DesktopRenderSettings''' component is used to set [[Settings]] used in Desktop mode. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|FieldOfView|Float| | |FieldOfView|Float| The fov of the desktop client. | ||
|SprintFieldOfViewZoom|Bool| | |SprintFieldOfViewZoom|Bool| Whether to multiply the FOV when sprinting | ||
|VSync|Bool| | |VSync|Bool| Whether to use VSync | ||
|LimitFramerateWhenUnfocused|Bool| | |LimitFramerateWhenUnfocused|Bool| Whether to limit framerate when the game is unfocused. | ||
|MaximumBackgroundFramerate|Int| | |MaximumBackgroundFramerate|Int| How much to limit the framerate when unfocused and <code>LimitFramerateWhenUnfocused</code> is true. | ||
|FramePacingOptionsEnabled|Bool| | |FramePacingOptionsEnabled|Bool| Whether to pace frames due to options like <code>MaximumBackgroundFramerate</code> is being used. | ||
|BackgroundFramerateEnabled|Bool| | |BackgroundFramerateEnabled|Bool| Whether to render new frames when in the background. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
== See Also == | == See Also == | ||
* [[Settings#Desktop Render Settings|Desktop Render Settings]] | |||
* [[Dash]] | |||
[[Category:Components:Uncategorized{{#translation:}}|Desktop Render Settings]] | [[Category:Components:Uncategorized{{#translation:}}|Desktop Render Settings]] | ||
[[Category:Components{{#translation:}}|Desktop Render Settings]] | [[Category:Components{{#translation:}}|Desktop Render Settings]] | ||
Latest revision as of 01:13, 23 December 2024
Component image 
Desktop Render Settings component as seen in the Scene Inspector
The DesktopRenderSettings component is used to set Settings used in Desktop mode.
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. Some components stop their functionality when this field is disabled, but some don't. |
FieldOfView
|
Float | The fov of the desktop client. |
SprintFieldOfViewZoom
|
Bool | Whether to multiply the FOV when sprinting |
VSync
|
Bool | Whether to use VSync |
LimitFramerateWhenUnfocused
|
Bool | Whether to limit framerate when the game is unfocused. |
MaximumBackgroundFramerate
|
Int | How much to limit the framerate when unfocused and LimitFramerateWhenUnfocused is true.
|
FramePacingOptionsEnabled
|
Bool | Whether to pace frames due to options like MaximumBackgroundFramerate is being used.
|
BackgroundFramerateEnabled
|
Bool | Whether to render new frames when in the background. |