org.jire.arrowhead.windows.User32.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Thomas Nappo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jire.arrowhead.windows

import com.sun.jna.Native

/**
 * Provides zero-garbage fast access to [GetKeyState].
 */
object User32 {

	/**
	 * Retrieves the status of the specified virtual key.
	 *
	 * The status specifies whether the key is up, down, or toggled
	 * (on, off—alternating each time the key is pressed).
	 *
	 * @param nVirtKey A virtual key. If the desired virtual key is a letter or digit
	 * (_A_ through _Z_, _a_ through _z_, or _0_ through _9_), `nVirtKey` must be set to the ASCII value
	 * of that character. For other keys, it must be a virtual-key code.
	 *
	 * If a non-English keyboard layout is used, virtual keys with values in the range ASCII
	 * _A_ through _Z_ and _0_ through _9_ are used to specify most of the character keys. For example,
	 * for the German keyboard layout, the virtual key of value ASCII _O_ (_0x4F_) refers to the "o" key,
	 * whereas _VK_OEM_1_ refers to the "o with umlaut" key.
	 */
	@JvmStatic
	external fun GetKeyState(nVirtKey: Int): Short

	init {
		Native.register("user32")
	}

}