Clarified KeyboardDevice.KeyRepeat documentation.
This commit is contained in:
parent
7fee81afcf
commit
a70754da07
1 changed files with 12 additions and 3 deletions
|
@ -99,11 +99,20 @@ namespace OpenTK.Input
|
|||
#region public bool KeyRepeat
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether key repeat status.
|
||||
/// Gets or sets a System.Boolean indicating key repeat status.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Setting key repeat to on will generate multiple KeyDown events when a key is held pressed.
|
||||
/// Setting key repeat to on will generate only one KeyDown/KeyUp event pair when a key is held pressed.
|
||||
/// If KeyRepeat is true, multiple KeyDown events will be generated while a key is being held.
|
||||
/// 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>
|
||||
public bool KeyRepeat
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue