WWW-www.enlightenment.org pushed a commit to branch master.
http://git.enlightenment.org/website/www-content.git/commit/?id=a697e0d33ee92d126b1d1540421fe67cf3822f65
commit a697e0d33ee92d126b1d1540421fe67cf3822f65
Author: Lauro Moura <lauromo...@expertisesolutions.com.br>
Date: Thu Dec 10 08:03:29 2015 -0800
Wiki page throttle changed with summary [] by Lauro Moura
---
pages/api/javascript/ecore/throttle.txt | 23 +++++++++--------------
1 file changed, 9 insertions(+), 14 deletions(-)
diff --git a/pages/api/javascript/ecore/throttle.txt
b/pages/api/javascript/ecore/throttle.txt
index ea3e4c3..46fbaf5 100644
--- a/pages/api/javascript/ecore/throttle.txt
+++ b/pages/api/javascript/ecore/throttle.txt
@@ -4,39 +4,34 @@
**DRAFT**
-==== Constants ====
+These functions manage the amount of "voluntary throttling" ecore will do to
its main loop while running. This is intended to be used to limit animations
and wakeups when in a strict power management state. The higher the current
throttle value (which can be retrieved by ''efl.Ecore.Throttle.get()''), the
more throttling takes place. If the current throttle value is 0, then no
throttling takes place at all.
+The value represents how long the ecore main loop will sleep (in seconds)
before it goes into a fully idle state waiting for events, input or timing
events to wake it up. For example, if the current throttle level is 0.5, then
after every time the main loop cycles and goes into idle after processing all
events, the main loop will explicitly sleep for 0.5 seconds before sitting and
waiting for incoming events or timeouts, thus preventing animation, async IO
and network handling etc. for t [...]
==== Functions ====
-=== adjust(args) ===
+=== adjust(amount) ===
Syntax
<code javascript>
- code
+ efl.Ecore.Throttle.adjust(amount);
</code>
Parameters
- * parameters
+ * amount - A number with the amount that will be changed on the throttling
setting. Can be positive (increase throttle) or negative (decrease throttle).
-Return value
-
- * return
+Changes the throttling value by ''amount''.
-=== get(args) ===
+=== get() ===
Syntax
<code javascript>
- code
+ var throttle = efl.Ecore.Throttle.get();
</code>
-Parameters
-
- * parameters
-
Return value
- * return
\ No newline at end of file
+ * integer - The amount of throttling.
\ No newline at end of file
--
