sdlGetGamepadProperties function gamepad

int sdlGetGamepadProperties(
  1. Pointer<SdlGamepad> gamepad
)

Get the properties associated with an opened gamepad.

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

\param gamepad a gamepad identifier previously returned by SDL_OpenGamepad(). \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread.

\since This function is available since SDL 3.2.0.

extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepad *gamepad)

Implementation

int sdlGetGamepadProperties(Pointer<SdlGamepad> gamepad) {
  final sdlGetGamepadPropertiesLookupFunction = _libSdl
      .lookupFunction<
        Uint32 Function(Pointer<SdlGamepad> gamepad),
        int Function(Pointer<SdlGamepad> gamepad)
      >('SDL_GetGamepadProperties');
  return sdlGetGamepadPropertiesLookupFunction(gamepad);
}