Timer: Included basic doc

git-svn-id: svn://ultimatepp.org/upp/trunk@2101 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
koldo 2010-02-19 23:26:57 +00:00
parent b286a613b6
commit d90ecd32b0
2 changed files with 42 additions and 8 deletions

View file

@ -1,8 +1,8 @@
uses
Core;
file
Timer.h,
Timer.cpp;
uses
Core;
file
Timer.h,
Timer.cpp,
srcdoc.tpp;

View file

@ -0,0 +1,34 @@
topic "Timer";
[ $$0,0#00000000000000000000000000000000:Default]
[{_}%EN-US
[s0; [*R6 Timer]&]
[s0; &]
[s0; [2 Timer queue, usable without CtrlCore.]&]
[s0;2 &]
[s0; [2 Some characteristics:]&]
[s0;2 &]
[s0;i150;O0; [2 The Interface is the same as used from the Ctrl`::TimerCallback
in CtrlCore]&]
[s0;2 &]
[s0;i150;O0; [2 To use it one does `*not`* need CtrlCore anymore, simply
Core and Timer, where the application has a Timer instance.]&]
[s0;2 &]
[s0;i150;O0; [2 Should keep in mind, that it`'s a timer `*queue`* other
things wont get to execution, until a current task is finished,
and the timer queue can check whether time has come for the next
task.]&]
[s0;2 &]
[s0;i150;O0; [2 Because of it, the timing is not as accurate as maybe
desired and can have `"timer glitches/jitter`", depending on
work load..]&]
[s0;2 &]
[s0;i150;O0; [2 Favorite use is to schedule some `*non`*`-timing`-critical
work for `"somewhere`-around`-in`-the`-future`".]&]
[s0;2 &]
[s0;i150;O0; [2 For timing critical stuff, consider using OS native
timer means, for WIN32 SetTimer (in windowing environment, using
WM`_TIMER callback) or CreateWaitableTimer for windowing`-independent
stuff, or even QueryPerformanceCounter. for Linux/Unix/Posix
settimer function, but for Linux there is a lot anyway.]&]
[s0;2 &]
[s0; ]