logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_GetGamepadProperties - Get the properties associated with an opened gamepad.

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10                        SDL_GetGamepadProperties(3)

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

Header File

       Defined in SDL3/SDL_gamepad.h

Name

       SDL_GetGamepadProperties - Get the properties associated with an opened gamepad.

Return Value

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

Synopsis

#include"SDL3/SDL.h"SDL_PropertiesIDSDL_GetGamepadProperties(SDL_Gamepad*gamepad);

See Also