SDL_GetGamepadProperties - Man Page

Get the properties associated with an opened gamepad.

Header File

Defined in SDL3/SDL_gamepad.h

Synopsis

#include "SDL3/SDL.h"

SDL_PropertiesID SDL_GetGamepadProperties(SDL_Gamepad *gamepad);

Description

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.

Info

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS