ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2024-12-26 05:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified KeyboardDevice.KeyRepeat documentation.

Browse source
This commit is contained in:
the_fiddler 2007-12-09 19:54:08 +00:00
parent 7fee81afcf
commit a70754da07
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Source/OpenTK/Input/KeyboardDevice.cs
View file

@ -99,11 +99,20 @@ namespace OpenTK.Input
#region public bool KeyRepeat #region public bool KeyRepeat
/// <summary> /// <summary>
/// Gets or sets a value indicating whether key repeat status. /// Gets or sets a System.Boolean indicating key repeat status.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Setting key repeat to on will generate multiple KeyDown events when a key is held pressed. /// If KeyRepeat is true, multiple KeyDown events will be generated while a key is being held.
/// Setting key repeat to on will generate only one KeyDown/KeyUp event pair when a key is held pressed. /// Otherwise only one KeyDown event will be reported.
/// <para>
/// The rate of the generated KeyDown events is controlled by the Operating System. Usually,
/// one KeyDown event will be reported, followed by a small (250-1000ms) pause and several
/// more KeyDown events (6-30 events per second).
/// </para>
/// <para>
/// Set to true to handle text input (where keyboard repeat is desirable), but set to false
/// for game input.
/// </para>
/// </remarks> /// </remarks>
public bool KeyRepeat public bool KeyRepeat
{ {