(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetJoystickInstanceID

Get the instance ID of an opened joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

SDL_JoystickID SDL_GetJoystickInstanceID(SDL_Joystick *joystick);

Function Parameters

joystick an SDL_Joystick structure containing joystick information

Return Value

Returns the instance ID of the specified joystick on success or 0 on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryJoystick