gamepad
moon add Milky2018/gamepad@0.4.7
Download zipAuthor
Version
0.4.7
License
Apache-2.0
Last updated
13 days ago
Downloads
6K
README#Milky2018/gamepad
Milky2018/gamepad is a MoonBit gamepad input library for native targets. It provides gil-style events, state tracking, SDL controller mappings, input filters, force-feedback APIs, and a mock backend for tests.
#Install
moon add Milky2018/gamepadUse the native target for real device input:
moon test --target native
moon run --target native#Platform Support
Best support today is on macOS. Linux and Windows are available on native targets as well.
#Features
- Native gamepad discovery and hotplug events
- Gil event polling and blocking waits
- Per-device state tracking through Gamepad and GamepadState
- SDL controller mapping database support, including bundled mappings
- Input filters: jitter, deadzone, axis_dpad_to_button, Repeat
- Force-feedback APIs with platform-specific backend support
- Mock backend for deterministic tests
#API Notes
- Errors: Gil::new() does not raise. GilBuilder::build() may raise GilError.
- Event time: Event::time() is a millisecond timestamp. On native backends this comes from the OS clock; on the mock backend it is whatever you set in Event::at(...).
- Mappings (gil naming): Rust gil re-exports MappingData as Mapping. In this MoonBit port, the user-editable type is MappingData; Mapping is the parsed SDL mapping used by Gil.
- Filters: Compose filters with filter_ev. If you write a custom filter, it must not turn Some(event) into None; to drop an event return Some(event.drop()).
#Force Feedback
- macOS: not supported (will report is_ff_supported = false).
- Linux/Windows: supported when the backend/device supports rumble.
#Quick Start
///|
test "quick start" {
let gil = Gil::new()
while true {
match gil.next_event() {
None => break
Some(ev) => ...
}
}
}#Mock Example
///|
test "mock button press" {
let gil = GilBuilder::new()
.with_mock_gamepad_count(1)
.with_default_filters(false)
.build()
let id = @gamepad.GamepadId(0)
gil.insert_event(Event::at(id, ButtonPressed(South, BTN_SOUTH), 0L))
assert_true(gil.next_event() is Some(_))
}#Notes
- Code values are backend-specific raw input codes.
- On macOS, some raw HID axes such as Rx and Ry may need SDL mappings before they resolve to semantic Axis values.
- On macOS, PowerInfo currently reports Unknown.
- On non-native targets, the package builds with a stub backend and does not provide real device events.
- Force-feedback repeat mode is exposed as FfRepeat.
#License
Apache-2.0.
#GilError
type GilError#MappingError
type MappingError#ParserError
type ParserError#Axis
pub(all) enum Axis {
LeftStickX
LeftStickY
LeftZ
RightStickX
RightStickY
RightZ
DPadX
DPadY
Unknown
}#AxisData
pub struct AxisData {
last_event_ts : Int64
last_event_c : Int64
value : Double
}#AxisInfo
pub struct AxisInfo {
min : Int
max : Int
deadzone : Int?
}#AxisOrBtn
#BaseEffect
#Button
pub(all) enum Button {
South
East
C
North
West
Z
LeftTrigger
RightTrigger
LeftTrigger2
RightTrigger2
Select
Start
Mode
LeftThumb
RightThumb
DPadUp
DPadDown
DPadLeft
DPadRight
Unknown
}#ButtonData
pub struct ButtonData {
last_event_ts : Int64
counter : Int64
value : Double
is_pressed : Bool
is_repeating : Bool
}#DistanceModel
pub enum DistanceModel {
None
Linear(ref_distance~ : Double, rolloff_factor~ : Double, max_distance~ : Double)
LinearClamped(ref_distance~ : Double, rolloff_factor~ : Double, max_distance~ : Double)
Inverse(ref_distance~ : Double, rolloff_factor~ : Double)
InverseClamped(ref_distance~ : Double, rolloff_factor~ : Double, max_distance~ : Double)
Exponential(ref_distance~ : Double, rolloff_factor~ : Double)
ExponentialClamped(ref_distance~ : Double, rolloff_factor~ : Double, max_distance~ : Double)
}#DistanceModel::validate
#Effect
pub struct Effect {
gil : Gil
effect_token : Int
gamepads : Array[GamepadId]
strong : Double
weak : Double
duration_ms : Int64
base_effects : Array[BaseEffect]
repeat_mode : FfRepeat
distance_model : DistanceModel
position : (Double, Double, Double)
gain : Double
playing_since_ms : Int64?
}#Effect::add_gamepad
#Effect::set_distance_model
#Effect::set_gamepads
#Effect::set_position
#EffectBuilder
pub struct EffectBuilder {
gamepads : Array[GamepadId]
base_effects : Array[BaseEffect]
repeat_mode : FfRepeat
distance_model : DistanceModel
position : (Double, Double, Double)
gain : Double
strong : Double
weak : Double
duration_ms : Int64
}#EffectBuilder::add_effect
#EffectBuilder::add_gamepad
#EffectBuilder::add_gamepad_id
#EffectBuilder::distance_model
#EffectBuilder::duration
#EffectBuilder::finish
#EffectBuilder::gain
#EffectBuilder::gamepads
#EffectBuilder::position
fn EffectBuilder::position(self : EffectBuilder, position : (Double, Double, Double)) -> EffectBuilder#EffectBuilder::repeat
#EffectBuilder::rumble
#Envelope
pub struct Envelope {
attack_length : Int
attack_level : Double
fade_length : Int
fade_level : Double
}#Event
#EventType
#Gamepad
#Gamepad::axis_or_btn_name
#Gamepad::set_listener_position
#GamepadData
pub struct GamepadData {
state : GamepadState
connected : Bool
mapping : Mapping
name : String
uuid : Uuid
vendor_id : Int?
product_id : Int?
ff_supported : Bool
listener_position : (Double, Double, Double)
power_info : PowerInfo
axes : Array[Int]
buttons : Array[Int]
axis_info : Array[(Int, AxisInfo)]
deadzones : Array[(Int, Double)]
have_sent_nonzero_for_axis : Array[Bool]
}#GamepadId
pub struct GamepadId {
value : Int
}#GamepadState
#GamepadState::axes_entries
#GamepadState::axis_data
#GamepadState::button_data
#GamepadState::buttons_entries
#Gil
pub struct Gil {
counter : Int64
update_state : Bool
default_filters : Bool
axis_to_btn_pressed : Double
axis_to_btn_released : Double
events : Array[Event]
events_head : Int
gamepads_data : Array[GamepadData]
mappings : MappingDb
now_ms : Int64
next_effect_token : Int
ff_tick_base_ms : Int64
ff_tick : Int
ff_dirty : Bool
ff_effects : Array[FfEffectSource]
ff_events : Array[Event]
ff_events_head : Int
backend : NativeBackend?
}#Gil::axis_or_btn_name
#Gil::new_mock
#Gil::next_event_blocking
#Gil::set_axis_to_btn
#Gil::set_deadzone
#Gil::set_mapping_data
fn Gil::set_mapping_data(self : Gil, id : GamepadId, mapping_data : MappingData, name? : String?) -> String raise MappingError#Gil::set_mapping_data_strict
fn Gil::set_mapping_data_strict(self : Gil, id : GamepadId, mapping_data : MappingData, name? : String?) -> String raise MappingError#GilBuilder
pub struct GilBuilder {
update_state : Bool
default_filters : Bool
axis_to_btn_pressed : Double
axis_to_btn_released : Double
env_mappings : Bool
included_mappings : Bool
mock_gamepad_count : Int
use_native_backend : Bool
mapping_inputs : Array[String]
}#GilBuilder::add_env_mappings
#GilBuilder::add_included_mappings
#GilBuilder::add_mappings
#GilBuilder::set_axis_to_btn
fn GilBuilder::set_axis_to_btn(self : GilBuilder, pressed : Double, released : Double) -> GilBuilder#GilBuilder::set_update_state
#GilBuilder::with_default_filters
#GilBuilder::with_mock_gamepad_count
#GilBuilder::with_native_backend
#Jitter
pub struct Jitter {
threshold : Double
}#Mapping
#Mapping::from_data
fn Mapping::from_data(data : MappingData, buttons : Array[Int], axes : Array[Int], name : String, uuid : Uuid) -> (Mapping, String) raise MappingError#Mapping::parse_sdl_mapping
fn Mapping::parse_sdl_mapping(line : String, buttons : Array[Int], axes : Array[Int]) -> Mapping raise ParseSdlMappingError#MappingData
#MappingData::insert_axis
#MappingData::insert_btn
#MappingData::remove_button
#MappingDb
#MappingDb::add_included_mappings
#NativeBackend
#NativeBackend::axis_info
#NativeBackend::buttons
#NativeBackend::is_connected
#NativeBackend::is_ff_supported
#NativeBackend::last_gamepad_hint
#NativeBackend::poll_timeout
#NativeBackend::power_info
#NativeBackend::product_id
#NativeBackend::set_rumble
fn NativeBackend::set_rumble(self : NativeBackend, id : Int, strong : Double, weak : Double, duration_ms : Int) -> Bool#NativeBackend::uuid_simple
#NativeEvent
#NativeEventTag
pub(all) enum NativeEventTag {
Connected
Disconnected
ButtonPressed
ButtonReleased
AxisChanged
ButtonChanged
}#ParserErrorKind
pub(all) enum ParserErrorKind {
InvalidGuid
InvalidKeyValPair
InvalidValue
EmptyValue
UnknownAxis
UnknownButton
InvalidParserState
UnexpectedEnd
}#Repeat
pub struct Repeat {
after_ms : Int64
every_ms : Int64
}#Replay
pub struct Replay {
after : Int
play_for : Int
with_delay : Int
}#Ticks
pub struct Ticks {
ms : Int64
}#Token
#Uuid
pub struct Uuid {
simple : String
}
0.4.7
Apache-2.0
Updated 13 days ago
6K downloads