(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetJoystickProperties

Get the properties associated with a joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

SDL_PropertiesID SDL_GetJoystickProperties(SDL_Joystick *joystick);

Function Parameters

SDL_Joystick *

joystick

the SDL_Joystick obtained from SDL_OpenJoystick().

Return Value

(SDL_PropertiesID) Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

Remarks

The following read-only properties are provided by SDL:

• SDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN: true if this joystick has an LED that has adjustable brightness
• SDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN: true if this joystick has an LED that has adjustable color
• SDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN: true if this joystick has a player LED
• SDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN: true if this joystick has left/right rumble
• SDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN: true if this joystick has simple trigger rumble

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.