inpututil

Documentation

Overview

Package inpututil provides utility functions of input like keyboard or mouse.

Index

• func AppendJustConnectedGamepadIDs(gamepadIDs []ebiten.GamepadID) []ebiten.GamepadID
• func AppendJustPressedTouchIDs(touchIDs []ebiten.TouchID) []ebiten.TouchID
• func AppendJustReleasedTouchIDs(touchIDs []ebiten.TouchID) []ebiten.TouchID
• func AppendPressedKeys(keys []ebiten.Key) []ebiten.Key
• func GamepadButtonPressDuration(id ebiten.GamepadID, button ebiten.GamepadButton) int
• func IsGamepadButtonJustPressed(id ebiten.GamepadID, button ebiten.GamepadButton) bool
• func IsGamepadButtonJustReleased(id ebiten.GamepadID, button ebiten.GamepadButton) bool
• func IsGamepadJustDisconnected(id ebiten.GamepadID) bool
• func IsKeyJustPressed(key ebiten.Key) bool
• func IsKeyJustReleased(key ebiten.Key) bool
• func IsMouseButtonJustPressed(button ebiten.MouseButton) bool
• func IsMouseButtonJustReleased(button ebiten.MouseButton) bool
• func IsStandardGamepadButtonJustPressed(id ebiten.GamepadID, button ebiten.StandardGamepadButton) bool
• func IsStandardGamepadButtonJustReleased(id ebiten.GamepadID, button ebiten.StandardGamepadButton) bool
• func IsTouchJustReleased(id ebiten.TouchID) bool
• func JustConnectedGamepadIDs() []ebiten.GamepadID
• func JustPressedTouchIDs() []ebiten.TouchID
• func KeyPressDuration(key ebiten.Key) int
• func MouseButtonPressDuration(button ebiten.MouseButton) int
• func PressedKeys() []ebiten.Key
• func StandardGamepadButtonPressDuration(id ebiten.GamepadID, button ebiten.StandardGamepadButton) int
• func TouchPositionInPreviousTick(id ebiten.TouchID) (int, int)
• func TouchPressDuration(id ebiten.TouchID) int

Functions

func AppendJustConnectedGamepadIDs

func AppendJustConnectedGamepadIDs(gamepadIDs []ebiten.GamepadID) []ebiten.GamepadID

AppendJustConnectedGamepadIDs appends gamepad IDs that are connected just in the current tick to gamepadIDs, and returns the extended buffer. Giving a slice that already has enough capacity works efficiently.

AppendJustConnectedGamepadIDs is concurrent safe.

func AppendJustPressedTouchIDs

func AppendJustPressedTouchIDs(touchIDs []ebiten.TouchID) []ebiten.TouchID

AppendJustPressedTouchIDs append touch IDs that are created just in the current tick to touchIDs, and returns the extended buffer. Giving a slice that already has enough capacity works efficiently.

AppendJustPressedTouchIDs is concurrent safe.

func AppendJustReleasedTouchIDs

func AppendJustReleasedTouchIDs(touchIDs []ebiten.TouchID) []ebiten.TouchID

AppendJustReleasedTouchIDs append touch IDs that are released just in the current tick to touchIDs, and returns the extended buffer. Giving a slice that already has enough capacity works efficiently.

AppendJustReleasedTouchIDs is concurrent safe.

func AppendPressedKeys

func AppendPressedKeys(keys []ebiten.Key) []ebiten.Key

AppendPressedKeys append currently pressed keyboard keys to keys and returns the extended buffer. Giving a slice that already has enough capacity works efficiently.

AppendPressedKeys is concurrent safe.

func GamepadButtonPressDuration

func GamepadButtonPressDuration(id ebiten.GamepadID, button ebiten.GamepadButton) int

GamepadButtonPressDuration returns how long the gamepad button of the gamepad id is pressed in ticks (Update).

GamepadButtonPressDuration is concurrent safe.

func IsGamepadButtonJustPressed

func IsGamepadButtonJustPressed(id ebiten.GamepadID, button ebiten.GamepadButton) bool

IsGamepadButtonJustPressed returns a boolean value indicating whether the given gamepad button of the gamepad id is pressed just in the current tick.

IsGamepadButtonJustPressed is concurrent safe.

func IsGamepadButtonJustReleased

func IsGamepadButtonJustReleased(id ebiten.GamepadID, button ebiten.GamepadButton) bool

IsGamepadButtonJustReleased returns a boolean value indicating whether the given gamepad button of the gamepad id is released just in the current tick.

IsGamepadButtonJustReleased is concurrent safe.

func IsGamepadJustDisconnected

func IsGamepadJustDisconnected(id ebiten.GamepadID) bool

IsGamepadJustDisconnected returns a boolean value indicating whether the gamepad of the given id is released just in the current tick.

IsGamepadJustDisconnected is concurrent safe.

func IsKeyJustPressed

func IsKeyJustPressed(key ebiten.Key) bool

IsKeyJustPressed returns a boolean value indicating whether the given key is pressed just in the current tick.

IsKeyJustPressed is concurrent safe.

func IsKeyJustReleased

func IsKeyJustReleased(key ebiten.Key) bool

IsKeyJustReleased returns a boolean value indicating whether the given key is released just in the current tick.

IsKeyJustReleased is concurrent safe.

func IsMouseButtonJustPressed

func IsMouseButtonJustPressed(button ebiten.MouseButton) bool

IsMouseButtonJustPressed returns a boolean value indicating whether the given mouse button is pressed just in the current tick.

IsMouseButtonJustPressed is concurrent safe.

func IsMouseButtonJustReleased

func IsMouseButtonJustReleased(button ebiten.MouseButton) bool

IsMouseButtonJustReleased returns a boolean value indicating whether the given mouse button is released just in the current tick.

IsMouseButtonJustReleased is concurrent safe.

func IsStandardGamepadButtonJustPressed

func IsStandardGamepadButtonJustPressed(id ebiten.GamepadID, button ebiten.StandardGamepadButton) bool

IsStandardGamepadButtonJustPressed returns a boolean value indicating whether the given standard gamepad button of the gamepad id is pressed just in the current tick.

IsStandardGamepadButtonJustPressed is concurrent safe.

func IsStandardGamepadButtonJustReleased

func IsStandardGamepadButtonJustReleased(id ebiten.GamepadID, button ebiten.StandardGamepadButton) bool

IsStandardGamepadButtonJustReleased returns a boolean value indicating whether the given standard gamepad button of the gamepad id is released just in the current tick.

IsStandardGamepadButtonJustReleased is concurrent safe.

func IsTouchJustReleased

func IsTouchJustReleased(id ebiten.TouchID) bool

IsTouchJustReleased returns a boolean value indicating whether the given touch is released just in the current tick.

IsTouchJustReleased is concurrent safe.

func JustConnectedGamepadIDs

func JustConnectedGamepadIDs() []ebiten.GamepadID

JustConnectedGamepadIDs returns gamepad IDs that are connected just in the current tick.

Deprecated: as of v2.2. Use AppendJustConnectedGamepadIDs instead.

func JustPressedTouchIDs

func JustPressedTouchIDs() []ebiten.TouchID

JustPressedTouchIDs returns touch IDs that are created just in the current tick.

Deprecated: as of v2.2. Use AppendJustPressedTouchIDs instead.

func KeyPressDuration

func KeyPressDuration(key ebiten.Key) int

KeyPressDuration returns how long the key is pressed in ticks (Update).

KeyPressDuration is concurrent safe.

func MouseButtonPressDuration

func MouseButtonPressDuration(button ebiten.MouseButton) int

MouseButtonPressDuration returns how long the mouse button is pressed in ticks (Update).

MouseButtonPressDuration is concurrent safe.

func PressedKeys

func PressedKeys() []ebiten.Key

PressedKeys returns a set of currently pressed keyboard keys.

Deprecated: as of v2.2. Use AppendPressedKeys instead.

func StandardGamepadButtonPressDuration

func StandardGamepadButtonPressDuration(id ebiten.GamepadID, button ebiten.StandardGamepadButton) int

StandardGamepadButtonPressDuration returns how long the standard gamepad button of the gamepad id is pressed in ticks (Update).

StandardGamepadButtonPressDuration is concurrent safe.

func TouchPositionInPreviousTick

func TouchPositionInPreviousTick(id ebiten.TouchID) (int, int)

TouchPositionInPreviousTick returns the position in the previous tick. If the touch is a just-released touch, TouchPositionInPreviousTick returns the last position of the touch.

TouchJustReleasedPosition is concurrent safe.

func TouchPressDuration

func TouchPressDuration(id ebiten.TouchID) int

TouchPressDuration returns how long the touch remains in ticks (Update).

TouchPressDuration is concurrent safe.