WinForm Animation Library
Public Member Functions | Properties | List of all members
WinFormAnimation.Timer Class Reference

The timer class, will execute your code in specific time frames More...

Public Member Functions

 Timer (Action< ulong > callback, FPSLimiterKnownValues fpsKnownLimit=FPSLimiterKnownValues.LimitThirty)
 Initializes a new instance of the Timer class. More...
 
 Timer (Action< ulong > callback, int fpsLimit)
 Initializes a new instance of the Timer class. More...
 
void ResetClock ()
 The method to reset the time of the starting frame/tick More...
 
void Resume ()
 The method to resume the timer after stopping it More...
 
void Start ()
 The method to start the timer from the beginning More...
 
void Stop ()
 The method to stop the timer from generating any new ticks/frames More...
 

Properties

long LastTick [get]
 Gets the time of the last frame/tick related to the global-timer start reference More...
 
int FrameLimiter [get, set]
 Gets or sets the maximum frames/ticks per second More...
 
long FirstTick [get]
 Gets the time of the first frame/tick related to the global-timer start reference More...
 

Detailed Description

The timer class, will execute your code in specific time frames

Definition at line 11 of file Timer.cs.

Constructor & Destructor Documentation

WinFormAnimation.Timer.Timer ( Action< ulong >  callback,
FPSLimiterKnownValues  fpsKnownLimit = FPSLimiterKnownValues.LimitThirty 
)

Initializes a new instance of the Timer class.

Parameters
callbackThe callback to be executed at each tick
fpsKnownLimitThe max ticks per second

Definition at line 32 of file Timer.cs.

WinFormAnimation.Timer.Timer ( Action< ulong >  callback,
int  fpsLimit 
)

Initializes a new instance of the Timer class.

Parameters
callbackThe callback to be executed at each tick
fpsLimitThe max ticks per second

Definition at line 46 of file Timer.cs.

Member Function Documentation

void WinFormAnimation.Timer.ResetClock ( )

The method to reset the time of the starting frame/tick

Definition at line 126 of file Timer.cs.

void WinFormAnimation.Timer.Resume ( )

The method to resume the timer after stopping it

Definition at line 134 of file Timer.cs.

void WinFormAnimation.Timer.Start ( )

The method to start the timer from the beginning

Definition at line 147 of file Timer.cs.

void WinFormAnimation.Timer.Stop ( )

The method to stop the timer from generating any new ticks/frames

Definition at line 160 of file Timer.cs.

Property Documentation

long WinFormAnimation.Timer.FirstTick
get

Gets the time of the first frame/tick related to the global-timer start reference

Definition at line 77 of file Timer.cs.

int WinFormAnimation.Timer.FrameLimiter
getset

Gets or sets the maximum frames/ticks per second

Definition at line 72 of file Timer.cs.

long WinFormAnimation.Timer.LastTick
get

Gets the time of the last frame/tick related to the global-timer start reference

Definition at line 67 of file Timer.cs.


The documentation for this class was generated from the following file: