ebiten/input.go

220 lines
6.9 KiB
Go
Raw Normal View History

2015-02-01 13:47:47 +01:00
// Copyright 2015 Hajime Hoshi
//
// 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 ebiten
import (
2020-10-03 19:35:13 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/driver"
2015-02-01 13:47:47 +01:00
)
2017-08-14 21:11:51 +02:00
// InputChars return "printable" runes read from the keyboard at the time update is called.
//
// InputChars represents the environment's locale-dependent translation of keyboard
// input to Unicode characters.
//
2017-09-30 18:59:34 +02:00
// IsKeyPressed is based on a mapping of device (US keyboard) codes to input device keys.
2017-08-14 21:11:51 +02:00
// "Control" and modifier keys should be handled with IsKeyPressed.
//
// InputChars is concurrent-safe.
//
// On Android (ebitenmobile), EbitenView must be focusable to enable to handle keyboard keys.
//
// Keyboards don't work on iOS yet (#1090).
2017-08-14 21:11:51 +02:00
func InputChars() []rune {
rb := uiDriver().Input().RuneBuffer()
2017-08-14 21:11:51 +02:00
return append(make([]rune, 0, len(rb)), rb...)
}
2015-02-01 13:47:47 +01:00
// IsKeyPressed returns a boolean indicating whether key is pressed.
//
// If you want to know whether the key started being pressed in the current frame,
// use inpututil.IsKeyJustPressed
//
2018-04-21 18:39:28 +02:00
// Known issue: On Edge browser, some keys don't work well:
//
// - KeyKPEnter and KeyKPEqual are recognized as KeyEnter and KeyEqual.
// - KeyPrintScreen is only treated at keyup event.
//
// IsKeyPressed is concurrent-safe.
//
// On Android (ebitenmobile), EbitenView must be focusable to enable to handle keyboard keys.
//
// Keyboards don't work on iOS yet (#1090).
2015-02-01 13:47:47 +01:00
func IsKeyPressed(key Key) bool {
// There are keys that are invalid values as ebiten.Key (e.g., driver.KeyLeftAlt).
// Skip such values.
if !key.isValid() {
return false
}
var keys []driver.Key
switch key {
case KeyAlt:
keys = []driver.Key{driver.KeyLeftAlt, driver.KeyRightAlt}
case KeyControl:
keys = []driver.Key{driver.KeyLeftControl, driver.KeyRightControl}
case KeyShift:
keys = []driver.Key{driver.KeyLeftShift, driver.KeyRightShift}
default:
keys = []driver.Key{driver.Key(key)}
}
for _, k := range keys {
if uiDriver().Input().IsKeyPressed(k) {
return true
}
}
return false
2015-02-01 13:47:47 +01:00
}
2019-04-13 05:46:32 +02:00
// CursorPosition returns a position of a mouse cursor relative to the game screen (window). The cursor position is
// 'logical' position and this considers the scale of the screen.
//
// CursorPosition is concurrent-safe.
2015-02-01 13:47:47 +01:00
func CursorPosition() (x, y int) {
return uiDriver().Input().CursorPosition()
2015-02-01 13:47:47 +01:00
}
2018-10-11 15:36:38 +02:00
// Wheel returns the x and y offset of the mouse wheel or touchpad scroll.
2018-06-17 17:38:30 +02:00
// It returns 0 if the wheel isn't being rolled.
2018-10-11 15:36:38 +02:00
//
// Wheel is concurrent-safe.
2018-09-30 10:01:45 +02:00
func Wheel() (xoff, yoff float64) {
return uiDriver().Input().Wheel()
2018-06-17 17:38:30 +02:00
}
2015-02-01 13:47:47 +01:00
// IsMouseButtonPressed returns a boolean indicating whether mouseButton is pressed.
//
// If you want to know whether the mouseButton started being pressed in the current frame,
// use inpututil.IsMouseButtonJustPressed
//
// IsMouseButtonPressed is concurrent-safe.
2015-02-01 13:47:47 +01:00
func IsMouseButtonPressed(mouseButton MouseButton) bool {
return uiDriver().Input().IsMouseButtonPressed(driver.MouseButton(mouseButton))
2015-02-01 13:47:47 +01:00
}
// GamepadID represents a gamepad's identifier.
type GamepadID = driver.GamepadID
// GamepadSDLID returns a string with the GUID generated in the same way as SDL.
// To detect devices, see also the community project of gamepad devices database: https://github.com/gabomdq/SDL_GameControllerDB
//
// GamepadSDLID always returns an empty string on browsers and mobiles.
2020-01-09 15:05:29 +01:00
//
// GamepadSDLID is concurrent-safe.
func GamepadSDLID(id GamepadID) string {
return uiDriver().Input().GamepadSDLID(id)
}
// GamepadName returns a string with the name.
// This function may vary in how it returns descriptions for the same device across platforms.
// for example the following drivers/platforms see a Xbox One controller as the following:
//
2020-01-09 15:05:29 +01:00
// - Windows: "Xbox Controller"
// - Chrome: "Xbox 360 Controller (XInput STANDARD GAMEPAD)"
// - Firefox: "xinput"
//
// GamepadName always returns an empty string on mobiles.
2020-01-09 15:05:29 +01:00
//
// GamepadName is concurrent-safe.
func GamepadName(id GamepadID) string {
return uiDriver().Input().GamepadName(id)
}
// GamepadIDs returns a slice indicating available gamepad IDs.
2017-10-25 19:59:06 +02:00
//
// GamepadIDs is concurrent-safe.
2017-10-25 19:59:06 +02:00
//
// GamepadIDs always returns an empty slice on mobiles.
func GamepadIDs() []GamepadID {
return uiDriver().Input().GamepadIDs()
2017-10-25 19:59:06 +02:00
}
2017-09-30 18:59:34 +02:00
// GamepadAxisNum returns the number of axes of the gamepad (id).
2015-02-01 13:47:47 +01:00
//
// GamepadAxisNum is concurrent-safe.
//
// GamepadAxisNum always returns 0 on mobiles.
func GamepadAxisNum(id GamepadID) int {
return uiDriver().Input().GamepadAxisNum(id)
2015-02-01 13:47:47 +01:00
}
2017-09-30 18:59:34 +02:00
// GamepadAxis returns the float value [-1.0 - 1.0] of the given gamepad (id)'s axis (axis).
2015-02-01 13:47:47 +01:00
//
// GamepadAxis is concurrent-safe.
//
// GamepadAxis always returns 0 on mobiles.
func GamepadAxis(id GamepadID, axis int) float64 {
return uiDriver().Input().GamepadAxis(id, axis)
2015-02-01 13:47:47 +01:00
}
2017-09-30 18:59:34 +02:00
// GamepadButtonNum returns the number of the buttons of the given gamepad (id).
2015-02-01 13:47:47 +01:00
//
// GamepadButtonNum is concurrent-safe.
//
// GamepadButtonNum always returns 0 on mobiles.
func GamepadButtonNum(id GamepadID) int {
return uiDriver().Input().GamepadButtonNum(id)
2015-02-01 13:47:47 +01:00
}
2017-09-30 18:59:34 +02:00
// IsGamepadButtonPressed returns the boolean indicating the given button of the gamepad (id) is pressed or not.
2015-02-01 13:47:47 +01:00
//
// If you want to know whether the given button of gamepad (id) started being pressed in the current frame,
// use inpututil.IsGamepadButtonJustPressed
//
// IsGamepadButtonPressed is concurrent-safe.
//
2018-04-29 20:58:04 +02:00
// The relationships between physical buttons and buttion IDs depend on environments.
2016-10-29 11:17:25 +02:00
// There can be differences even between Chrome and Firefox.
//
// IsGamepadButtonPressed always returns false on mobiles.
func IsGamepadButtonPressed(id GamepadID, button GamepadButton) bool {
return uiDriver().Input().IsGamepadButtonPressed(id, driver.GamepadButton(button))
2015-02-01 13:47:47 +01:00
}
// TouchID represents a touch's identifier.
type TouchID = driver.TouchID
// TouchIDs returns the current touch states.
//
// If you want to know whether a touch started being pressed in the current frame,
// use inpututil.JustPressedTouchIDs
//
// TouchIDs returns nil when there are no touches.
// TouchIDs always returns nil on desktops.
//
// TouchIDs is concurrent-safe.
func TouchIDs() []TouchID {
return uiDriver().Input().TouchIDs()
}
// TouchPosition returns the position for the touch of the specified ID.
//
// If the touch of the specified ID is not present, TouchPosition returns (0, 0).
//
// TouchPosition is cuncurrent-safe.
func TouchPosition(id TouchID) (int, int) {
found := false
for _, i := range uiDriver().Input().TouchIDs() {
if id == i {
found = true
break
}
}
if !found {
return 0, 0
}
return uiDriver().Input().TouchPosition(id)
}