Updated constant's name and javadoc for issue jMonkeyEngine#682

DomenicDev · Jan 15, 2018 · e8bfd6f · e8bfd6f
1 parent 9b62fd3
commit e8bfd6f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/jme3-core/src/main/java/com/jme3/input/KeyInput.java b/jme3-core/src/main/java/com/jme3/input/KeyInput.java
@@ -446,12 +446,15 @@ public interface KeyInput extends Input {
      */
     public static final int KEY_UNLABELED = 0x97;
     /**
-     * Print Screen key.
-     * NOTE: Only use this if your Print Screen button
-     * is separated else LWJGL will interpret this key
-     * as <code>KEY_SYSRQ</code>
-     */
-    public static final int KEY_PRTSCREEN = 0x9A;
+     * PrtScr key.
+     * Note: for use on keyboards with a PrtScr key that is
+     * separate from the SysRq key. Most keyboards combine
+     * SysRq and PrtScr so if the intent is to actually
+     * capture the user's desire to capture the screen
+     * then SysRq is the most likely scan code.
+     * Use PrtScr to catch the rest (laptops, mini-keyboards, etc.)
+     */
+    public static final int KEY_PRTSCR = 0x9A;
     /**
      * Enter key (num pad).
      */

diff --git a/jme3-desktop/src/main/java/com/jme3/input/awt/AwtKeyInput.java b/jme3-desktop/src/main/java/com/jme3/input/awt/AwtKeyInput.java
@@ -371,7 +371,7 @@ public static int convertJmeCode( int key ) {
                 return KeyEvent.VK_ALT; //todo: location left
             case KEY_RMENU:
                 return KeyEvent.VK_ALT; //todo: location right
-            case KEY_PRTSCREEN:
+            case KEY_PRTSCR:
                 return KeyEvent.VK_PRINTSCREEN;
         }
         logger.log(Level.WARNING, "unsupported key:{0}", key);
@@ -603,7 +603,7 @@ public static int convertAwtKey(int key) {
             case KeyEvent.VK_META:
             	return KEY_RCONTROL;
             case KeyEvent.VK_PRINTSCREEN:
-                return KEY_PRTSCREEN;
+                return KEY_PRTSCR;
 
         }
         logger.log( Level.WARNING, "unsupported key:{0}", key);