SDL_GetGamepadProperties(3)

SDL_GetGamepadProperties3

Get the properties associated with an opened gamepad.

Usage

#include "SDL3/SDL.h"

SDL_PropertiesID SDL_GetGamepadProperties(SDL_Gamepad *gamepad);

Header file

Defined in SDL3/SDL_gamepad.h

Overview

These properties are shared with the underlying joystick object.

The following read-only properties are provided by SDL:

• SDL_PROP_GAMEPAD_CAP_MONO_LED_BOOLEAN :
true if this gamepad has an LED that has adjustable brightness

• SDL_PROP_GAMEPAD_CAP_RGB_LED_BOOLEAN :
true if this gamepad has an LED that has adjustable color

• SDL_PROP_GAMEPAD_CAP_PLAYER_LED_BOOLEAN :
true if this gamepad has a player LED

• SDL_PROP_GAMEPAD_CAP_RUMBLE_BOOLEAN :
true if this gamepad has left/right rumble

• SDL_PROP_GAMEPAD_CAP_TRIGGER_RUMBLE_BOOLEAN :
true if this gamepad has simple trigger rumble

Function parameters

gamepad

a gamepad identifier previously returned by SDL_OpenGamepad ().

Return value

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

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.