devela::_dep::sdl3::sys::gamepad

Function SDL_GetGamepadJoystick

pub unsafe extern "C" fn SDL_GetGamepadJoystick(
    gamepad: *mut SDL_Gamepad,
) -> *mut SDL_Joystick
Available on crate feature dep_sdl3 only.
Expand description

Get the underlying joystick from a gamepad.

This function will give you a SDL_Joystick object, which allows you to use the SDL_Joystick functions with a SDL_Gamepad object. This would be useful for getting a joystick’s position at any given time, even if it hasn’t moved (moving it would produce an event, which would have the axis’ value).

The pointer returned is owned by the SDL_Gamepad. You should not call SDL_CloseJoystick() on it, for example, since doing so will likely cause SDL to crash.

§Parameters

  • gamepad: the gamepad object that you want to get a joystick from.

§Return value

Returns an SDL_Joystick object, or NULL on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.