Browse Source

Added some documentation.

tags/2021-05-28
jules 12 years ago
parent
commit
64c984896e
2 changed files with 15 additions and 1 deletions
  1. +14
    -0
      modules/juce_core/threads/juce_HighResolutionTimer.h
  2. +1
    -1
      modules/juce_events/timers/juce_Timer.h

+ 14
- 0
modules/juce_core/threads/juce_HighResolutionTimer.h View File

@@ -26,6 +26,20 @@
#ifndef __JUCE_HIGHRESOLUTIONTIMER_JUCEHEADER__
#define __JUCE_HIGHRESOLUTIONTIMER_JUCEHEADER__
/**
A high-resolution periodic timer.
This provides accurately-timed regular callbacks. Unlike the normal Timer
class, this one uses a dedicated thread, not the message thread, so is
far more stable and precise.
You should only use this class in situations where you really need accuracy,
because unlike the normal Timer class, which is very lightweight and cheap
to start/stop, the HighResolutionTimer will use far more resources, and
starting/stopping it may involve launching and killing threads.
@see Timer
*/
class JUCE_API HighResolutionTimer
{
protected:


+ 1
- 1
modules/juce_events/timers/juce_Timer.h View File

@@ -48,7 +48,7 @@
structure is very similar to the Timer class, but contains multiple timers
internally, each one identified by an ID number.
@see MultiTimer
@see HighResolutionTimer, MultiTimer
*/
class JUCE_API Timer
{


Loading…
Cancel
Save