rayengine 0.0.3

A small Linux-first Rust game SDK over raylib
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
use super::*;

const MOVE: Axis = Axis(0);
const JUMP: Action = Action(0);

struct Backend {
    focused: bool,
    keys: Vec<KeyboardKey>,
    tap: bool,
    pad: Option<f32>,
    pad_button: bool,
    requested_device: i32,
}
impl Default for Backend {
    fn default() -> Self {
        Self {
            focused: true,
            keys: Vec::new(),
            tap: false,
            pad: None,
            pad_button: false,
            requested_device: 2,
        }
    }
}
impl PhysicalInput for Backend {
    fn focused(&self) -> bool {
        self.focused
    }
    fn available(&self, device: i32) -> bool {
        device == self.requested_device && self.pad.is_some()
    }
    fn button(&self, button: Button) -> (bool, bool) {
        match button {
            Button::Key(key) => (
                self.keys.contains(&key),
                key == KeyboardKey::KEY_SPACE && self.tap,
            ),
            Button::Gamepad { device, .. } => (
                device == self.requested_device && self.pad.is_some() && self.pad_button,
                false,
            ),
            _ => (false, false),
        }
    }
    fn axis(&self, device: i32, _: GamepadAxis) -> Option<f32> {
        if device == self.requested_device {
            self.pad
        } else {
            None
        }
    }
}
fn keyboard() -> AxisBinding {
    AxisBinding::new(AxisSource::Buttons {
        negative: KeyboardKey::KEY_A.into(),
        positive: KeyboardKey::KEY_D.into(),
    })
}
fn stick() -> AxisBinding {
    AxisBinding::new(AxisSource::Gamepad {
        device: 2,
        axis: GamepadAxis::GAMEPAD_AXIS_LEFT_X,
    })
}
fn trigger() -> AxisBinding {
    AxisBinding::new(AxisSource::Gamepad {
        device: 2,
        axis: GamepadAxis::GAMEPAD_AXIS_RIGHT_TRIGGER,
    })
}
fn close(actual: f32, expected: f32) {
    assert!((actual - expected).abs() < 1e-6, "{actual} != {expected}");
}

#[test]
fn normalization_dead_zone_inversion_sensitivity_and_invalid_samples() {
    let mut binding = stick();
    binding.dead_zone = 0.2;
    for raw in [-0.2, 0.0, 0.2] {
        close(binding.process(Some(raw)), 0.0);
    }
    close(binding.process(Some(0.6)), 0.5);
    close(binding.process(Some(-0.6)), -0.5);
    close(binding.process(Some(2.0)), 1.0);
    binding.inverted = true;
    binding.sensitivity = 2.0;
    close(binding.process(Some(0.6)), -1.0);
    close(binding.process(None), 0.0);
    close(binding.process(Some(f32::NAN)), 0.0);
    close(binding.process(Some(f32::INFINITY)), 0.0);
    let mut trigger = trigger();
    trigger.dead_zone = 0.0;
    close(trigger.process(Some(-1.0)), 0.0);
    close(trigger.process(Some(0.0)), 0.5);
    close(trigger.process(Some(1.0)), 1.0);
    close(trigger.process(None), 0.0); // Never turns missing raw zero into half pressure.
    trigger.inverted = true;
    close(trigger.process(Some(1.0)), -1.0);
}

#[test]
fn keyboard_and_controller_share_intent_with_stable_conflict_resolution() {
    let bindings = Bindings::new()
        .bind_axis(MOVE, keyboard())
        .unwrap()
        .bind_axis(MOVE, stick())
        .unwrap();
    let mut input = Input::default();
    let mut sampling = SamplingState::default();
    let mut backend = Backend {
        keys: vec![KeyboardKey::KEY_D],
        pad: Some(-0.6),
        ..Backend::default()
    };
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 1.0);
    backend.pad = Some(-1.0); // Equal magnitude: earlier keyboard wins.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 1.0);
    backend.keys.push(KeyboardKey::KEY_A); // Keyboard opposites cancel, stick still wins.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), -1.0);
    backend.keys.clear();
    backend.pad = Some(0.575);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.5);
    backend.requested_device = 0; // No implicit fallback to another device.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.0);
}

#[test]
fn values_and_button_edges_across_render_and_fixed_rates_disconnect_and_focus() {
    let bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind(
            JUMP,
            Button::Gamepad {
                device: 2,
                button: GamepadButton::GAMEPAD_BUTTON_RIGHT_FACE_DOWN,
            },
        )
        .bind_axis(MOVE, trigger())
        .unwrap();
    let mut backend = Backend {
        tap: true,
        pad: Some(-1.0),
        pad_button: true,
        ..Backend::default()
    };
    let mut input = Input::default();
    let mut sampling = SamplingState::default();
    bindings.sample_from(&backend, &mut input, &mut sampling); // Observe trigger release.
    backend.pad = Some(1.0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    backend.tap = false;
    bindings.sample_from(&backend, &mut input, &mut sampling); // No fixed update between these frames.
    assert!(input.pressed(JUMP));
    close(input.value(MOVE), 1.0);
    input.consume_edges();
    for _ in 0..3 {
        // Catch-up ticks retain velocity, never repeat edges.
        assert!(input.down(JUMP));
        assert!(!input.pressed(JUMP));
        close(input.value(MOVE), 1.0);
        input.consume_edges();
    }
    backend.pad = None;
    bindings.sample_from(&backend, &mut input, &mut sampling);
    assert!(input.released(JUMP));
    assert!(!input.down(JUMP));
    close(input.value(MOVE), 0.0);
    input.consume_edges();
    backend.tap = true; // Backend quick tap not held at sample time.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    assert!(input.pressed(JUMP) && input.released(JUMP));
    input.consume_edges();
    backend.keys.push(KeyboardKey::KEY_SPACE);
    backend.pad = Some(1.0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    backend.focused = false;
    bindings.sample_from(&backend, &mut input, &mut sampling);
    assert!(!input.down(JUMP) && input.released(JUMP) && input.reset_pending());
    close(input.value(MOVE), 0.0);
}

#[test]
fn button_or_release_one_source_does_not_release_action() {
    let bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind(JUMP, KeyboardKey::KEY_W);
    let mut backend = Backend {
        keys: vec![KeyboardKey::KEY_SPACE, KeyboardKey::KEY_W],
        ..Backend::default()
    };
    let mut input = Input::default();
    let mut sampling = SamplingState::default();
    bindings.sample_from(&backend, &mut input, &mut sampling);
    input.consume_edges();
    backend.keys.remove(0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    assert!(input.down(JUMP) && !input.released(JUMP) && !input.pressed(JUMP));
}

#[test]
fn runtime_rebind_remove_and_complete_replace_clear_only_changed_states() {
    let unchanged = Action(1);
    let mut bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind(unchanged, KeyboardKey::KEY_W)
        .bind_axis(MOVE, keyboard())
        .unwrap();
    let mut previous = bindings.clone();
    let mut backend = Backend {
        keys: vec![
            KeyboardKey::KEY_SPACE,
            KeyboardKey::KEY_W,
            KeyboardKey::KEY_D,
        ],
        ..Backend::default()
    };
    let mut input = Input::default();
    let mut sampling = SamplingState::default();
    bindings.sample_from(&backend, &mut input, &mut sampling);
    input.consume_edges();
    bindings
        .rebind(JUMP, vec![KeyboardKey::KEY_ENTER.into()])
        .unwrap();
    bindings.remove_axis(MOVE);
    bindings.reconcile(&mut previous, &mut input).unwrap();
    assert!(!input.down(JUMP) && input.released(JUMP));
    close(input.value(MOVE), 0.0);
    assert!(input.down(unchanged) && !input.released(unchanged));
    input.consume_edges(); // A second fixed tick before a new frame remains neutral.
    backend.keys.push(KeyboardKey::KEY_ENTER);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    assert!(input.down(JUMP) && input.pressed(JUMP));
    bindings.replace(BindingConfig::default()).unwrap();
    input.consume_edges();
    bindings.reconcile(&mut previous, &mut input).unwrap();
    assert!(input.released(JUMP) && input.released(unchanged));
    assert!(!input.down(JUMP) && !input.down(unchanged));
}

#[test]
fn invalid_runtime_changes_leave_previous_configuration_intact() {
    let mut bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind_axis(MOVE, keyboard())
        .unwrap();
    let previous = bindings.clone();
    let mut bad = stick();
    bad.dead_zone = 1.0;
    assert!(bindings.rebind_axis(MOVE, vec![bad]).is_err());
    assert!(
        bindings
            .rebind(
                JUMP,
                vec![Button::Gamepad {
                    device: -1,
                    button: GamepadButton::GAMEPAD_BUTTON_LEFT_THUMB
                }]
            )
            .is_err()
    );
    let mut config = bindings.config();
    config.schema_version = 99;
    assert!(bindings.replace(config).is_err());
    assert_eq!(bindings, previous);
    assert!(!bindings.remove_button(JUMP, KeyboardKey::KEY_ENTER.into()));
    assert!(bindings.remove_button(JUMP, KeyboardKey::KEY_SPACE.into()));
    assert!(bindings.buttons(JUMP).is_empty());
}

#[test]
fn settings_round_trip_all_sources_and_explicit_game_owned_files() {
    let mut bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind(JUMP, Button::Mouse(MouseButton::MOUSE_BUTTON_LEFT))
        .bind(
            JUMP,
            Button::Gamepad {
                device: 2,
                button: GamepadButton::GAMEPAD_BUTTON_RIGHT_FACE_DOWN,
            },
        )
        .bind_axis(MOVE, keyboard())
        .unwrap()
        .bind_axis(MOVE, stick())
        .unwrap();
    let mut trigger = trigger();
    trigger.inverted = true;
    trigger.sensitivity = 0.75;
    bindings.add_axis(Axis(1), trigger).unwrap();
    assert_eq!(
        Bindings::from_json(&bindings.to_json().unwrap()).unwrap(),
        bindings
    );
    let path = std::env::temp_dir().join(format!("rayengine-bindings-{}.json", std::process::id()));
    bindings.save(&path).unwrap();
    assert_eq!(Bindings::load(&path).unwrap(), bindings);
    std::fs::remove_file(&path).unwrap();
    assert!(matches!(Bindings::load(&path), Err(Error::Io(_))));
}

#[test]
fn invalid_configuration_reports_context_and_rejects_unknown_fields_and_enums() {
    let bindings = Bindings::new()
        .bind(JUMP, KeyboardKey::KEY_SPACE)
        .bind_axis(MOVE, stick())
        .unwrap();
    let mut config = bindings.config();
    config.actions.push(config.actions[0].clone());
    assert!(
        config
            .validate()
            .unwrap_err()
            .to_string()
            .contains("duplicate action ID")
    );
    let mut config = bindings.config();
    config.axes.push(config.axes[0].clone());
    assert!(
        config
            .validate()
            .unwrap_err()
            .to_string()
            .contains("duplicate axis ID")
    );
    for value in [f32::NAN, f32::INFINITY, -0.1, 1.0] {
        let mut config = bindings.config();
        config.axes[0].sources[0].dead_zone = value;
        assert!(
            config
                .validate()
                .unwrap_err()
                .to_string()
                .contains("axis 0 source 0: dead_zone")
        );
    }
    for value in [f32::NAN, f32::INFINITY, -1.0, 101.0] {
        let mut config = bindings.config();
        config.axes[0].sources[0].sensitivity = value;
        assert!(
            config
                .validate()
                .unwrap_err()
                .to_string()
                .contains("sensitivity")
        );
    }
    let json = bindings.to_json().unwrap();
    for invalid in [
        json.replace("KEY_SPACE", "KEY_UNKNOWN"),
        json.replace("\"schema_version\": 1", "\"schema_version\": 2"),
        json.replace(
            "\"schema_version\": 1",
            "\"schema_version\": 1, \"typo\": true",
        ),
        json.replace("\"dead_zone\": 0.15", "\"dead_zone\": 0.15, \"typo\": true"),
        json.replace("\"device\": 2", "\"device\": 4"),
        json.replace("\"device\": 2", "\"device\": -1"),
        json.replace("\"action\": 0", "\"action\": 65536"),
        json.replace("\"dead_zone\": 0.15", "\"dead_zone\": null"),
    ] {
        assert!(
            Bindings::from_json(&invalid).is_err(),
            "accepted: {invalid}"
        );
    }
}

#[test]
fn invalid_whole_set_assignment_is_rejected_before_reconciling_or_sampling() {
    let mut previous = Bindings::new().bind(JUMP, KeyboardKey::KEY_SPACE);
    let original = previous.clone();
    let mut input = Input::default();
    input.set(JUMP, true);
    input.consume_edges();
    for device in [-1, 4, i32::MIN, i32::MAX] {
        let assigned = Bindings::new().bind(
            JUMP,
            Button::Gamepad {
                device,
                button: GamepadButton::GAMEPAD_BUTTON_LEFT_THUMB,
            },
        );
        assert!(matches!(
            assigned.reconcile(&mut previous, &mut input),
            Err(Error::Config(_))
        ));
        assert_eq!(previous, original);
        assert!(input.down(JUMP) && !input.released(JUMP));
    }
}

#[test]
fn missing_mapped_triggers_stay_neutral_and_real_half_pressure_is_preserved() {
    let bindings = Bindings::new().bind_axis(MOVE, trigger()).unwrap();
    // GLFW's mapped gamepad state leaves absent trigger mappings at zero even
    // though raylib reports all six logical axes. Zero must not arm pressure.
    let mut backend = Backend {
        pad: Some(0.0),
        ..Backend::default()
    };
    let mut input = Input::default();
    let mut sampling = SamplingState::default();
    for _ in 0..3 {
        bindings.sample_from(&backend, &mut input, &mut sampling);
        close(input.value(MOVE), 0.0);
        input.consume_edges();
    }
    backend.pad = Some(1.0); // A real trigger held on connection is neutral too.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.0);
    backend.pad = Some(-1.0); // Release arms the physical trigger.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.0);
    backend.pad = Some(0.0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), (0.5 - 0.15) / 0.85); // Valid half-pressure remains usable.
    backend.focused = false;
    bindings.sample_from(&backend, &mut input, &mut sampling);
    backend.focused = true;
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.0); // Must release again after focus recovery.
    backend.pad = Some(-0.96); // Small endpoint drift still allows release.
    bindings.sample_from(&backend, &mut input, &mut sampling);
    backend.pad = Some(1.0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 1.0);
    // Disconnection while unbound still clears readiness for reused slots.
    let empty = Bindings::new();
    backend.pad = None;
    empty.sample_from(&backend, &mut input, &mut sampling);
    backend.pad = Some(0.0);
    bindings.sample_from(&backend, &mut input, &mut sampling);
    close(input.value(MOVE), 0.0);
}