[This is preliminary documentation and is subject to change.]
The UpdateFrequency property represents, in milliseconds, how often we are updating the Framerate._fps count.
Syntax
| Visual Basic (Declaration) |
|---|
Public Property UpdateFrequency As UShort |
| C# |
|---|
public ushort UpdateFrequency { get; set; } |
| C++ |
|---|
public: unsigned short UpdateFrequency { unsigned short get (); void set (unsigned short value); } |
Value
The UpdateFrequency property gets/sets the Framerate._updateFrequency data member.
Remarks
This is used to set how often we are calculating the frames per second count.
The default value is 1000.
Exceptions
| Exception | Condition |
|---|---|
| System.ArgumentOutOfRangeException | This exception will be thrown when the value is set less then 100 or when value is not divisible by 100. |