summaryrefslogtreecommitdiffstats
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-11-08 18:36:06 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-11-08 18:53:25 +0100
commite6d53ba75fe8d58d72fb6f4c261c7fcf73290104 (patch)
treec43ebb5a4f51a23dbaaadb2fa1f4df0d525633b4 /doc/classes
parent9d4e596c69b0b03e94af4ea4cfb49e0371776ec6 (diff)
downloadredot-engine-e6d53ba75fe8d58d72fb6f4c261c7fcf73290104.tar.gz
Expose the `OS.low_processor_usage_mode_sleep_usec` property
This makes it possible to change it at runtime in projects.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/OS.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 5aeeb61647..6da0547352 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -878,6 +878,9 @@
<member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode" default="false">
If [code]true[/code], the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile.
</member>
+ <member name="low_processor_usage_mode_sleep_usec" type="int" setter="set_low_processor_usage_mode_sleep_usec" getter="get_low_processor_usage_mode_sleep_usec" default="6900">
+ The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
+ </member>
<member name="max_window_size" type="Vector2" setter="set_max_window_size" getter="get_max_window_size" default="Vector2( 0, 0 )">
The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value.
</member>