Man page - sdl_getgamepadjoystick(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_GetGamepadJoystick

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY

---

NAME

SDL_GetGamepadJoystick - Get the underlying joystick from a gamepad.

HEADER FILE

Defined in SDL3/SDL_gamepad.h

SYNOPSIS

#include "SDL3/SDL.h"

SDL_Joystick * SDL_GetGamepadJoystick(SDL_Gamepad *gamepad);

DESCRIPTION

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.

FUNCTION PARAMETERS

gamepad

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

RETURN VALUE

( SDL_Joystick
*) 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.

---