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

Function SDL_SetJoystickVirtualTouchpad

pub unsafe extern "C" fn SDL_SetJoystickVirtualTouchpad(
    joystick: *mut SDL_Joystick,
    touchpad: i32,
    finger: i32,
    down: bool,
    x: f32,
    y: f32,
    pressure: f32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set touchpad finger state 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.
  • touchpad: the index of the touchpad on the virtual joystick to update.
  • finger: the index of the finger on the touchpad to set.
  • down: true if the finger is pressed, false if the finger is released.
  • x: the x coordinate of the finger on the touchpad, normalized 0 to 1, with the origin in the upper left.
  • y: the y coordinate of the finger on the touchpad, normalized 0 to 1, with the origin in the upper left.
  • pressure: the pressure of the finger.

§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.