From a70754da07b6b1561042669aa493c8d4ab277a97 Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Sun, 9 Dec 2007 19:54:08 +0000 Subject: [PATCH] Clarified KeyboardDevice.KeyRepeat documentation. --- Source/OpenTK/Input/KeyboardDevice.cs | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Source/OpenTK/Input/KeyboardDevice.cs b/Source/OpenTK/Input/KeyboardDevice.cs index 551acbee..e4673608 100644 --- a/Source/OpenTK/Input/KeyboardDevice.cs +++ b/Source/OpenTK/Input/KeyboardDevice.cs @@ -99,11 +99,20 @@ namespace OpenTK.Input #region public bool KeyRepeat /// - /// Gets or sets a value indicating whether key repeat status. + /// Gets or sets a System.Boolean indicating key repeat status. /// /// - /// 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. + /// + /// 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). + /// + /// + /// Set to true to handle text input (where keyboard repeat is desirable), but set to false + /// for game input. + /// /// public bool KeyRepeat {