dear-imgui-sdl3 0.15.0

SDL3 platform backend with optional OpenGL3 renderer for dear-imgui-rs
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

use super::*;

/// Gamepad handling mode used by the SDL3 backend.
///
/// This controls how many SDL3 gamepads are opened and merged into ImGui's
/// gamepad input state.
#[derive(Copy, Clone, Debug)]
pub enum GamepadMode {
    /// Automatically open the first available gamepad (Dear ImGui default).
    AutoFirst,
    /// Automatically open all available gamepads and merge their state.
    AutoAll,
}

/// Configure how the SDL3 backend handles gamepads.
///
/// Call this after backend initialization if you want a mode other than the
/// default `AutoFirst`.
///
/// This thin compatibility helper operates on Dear ImGui's current context.
/// Prefer [`set_gamepad_mode_for_context`] or an RAII backend owner in
/// multi-context code.
pub fn set_gamepad_mode(mode: GamepadMode) {
    unsafe {
        match mode {
            GamepadMode::AutoFirst => ffi::ImGui_ImplSDL3_SetGamepadMode_AutoFirst_Rust(),
            GamepadMode::AutoAll => ffi::ImGui_ImplSDL3_SetGamepadMode_AutoAll_Rust(),
        }
    }
}

/// Configure how the SDL3 backend handles gamepads for a specific context.
pub fn set_gamepad_mode_for_context(imgui: &mut Context, mode: GamepadMode) {
    with_context(imgui, "set_gamepad_mode_for_context()", || {
        set_gamepad_mode(mode);
    });
}

/// Configure SDL3 backend to use manual gamepad selection.
///
/// This thin compatibility helper operates on Dear ImGui's current context.
/// Prefer [`set_gamepad_mode_manual_for_context`] or an RAII backend owner in
/// multi-context code.
///
/// # Safety
///
/// - The caller must ensure every pointer in `gamepads` is a valid, opened `SDL_Gamepad`.
/// - The caller is responsible for keeping those gamepads alive for the duration of ImGui usage.
/// - The slice itself is only read during this call; the backend copies the pointers.
pub unsafe fn set_gamepad_mode_manual(gamepads: &[*mut sdl3_sys::gamepad::SDL_Gamepad]) {
    unsafe {
        ffi::ImGui_ImplSDL3_SetGamepadMode_Manual_Rust(gamepads.as_ptr(), gamepads.len() as i32);
    }
}

/// Configure SDL3 backend to use manual gamepad selection for a specific context.
///
/// # Safety
///
/// - The caller must ensure every pointer in `gamepads` is a valid, opened `SDL_Gamepad`.
/// - The caller is responsible for keeping those gamepads alive for the duration of ImGui usage.
/// - The slice itself is only read during this call; the backend copies the pointers.
pub unsafe fn set_gamepad_mode_manual_for_context(
    imgui: &mut Context,
    gamepads: &[*mut sdl3_sys::gamepad::SDL_Gamepad],
) {
    with_context(imgui, "set_gamepad_mode_manual_for_context()", || unsafe {
        set_gamepad_mode_manual(gamepads);
    });
}