devela::_dep::sdl3::sys::joystick

Function SDL_SetJoystickVirtualButton

pub unsafe extern "C" fn SDL_SetJoystickVirtualButton(
    joystick: *mut SDL_Joystick,
    button: i32,
    down: bool,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set the state of a button on an opened virtual joystick.

Please note that values set here will not be applied until the next call to SDL_UpdateJoysticks, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: [SDL_PollEvent], [SDL_PumpEvents], [SDL_WaitEventTimeout], [SDL_WaitEvent].

§Parameters

  • joystick: the virtual joystick on which to set state.
  • button: the index of the button on the virtual joystick to update.
  • down: true if the button is pressed, false otherwise.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.