---
name: "SDL_GetJoystickProperties"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetJoystickProperties"
---

# SDL\_GetJoystickProperties(3)

Get the properties associated with a joystick.

## NAME

SDL\_GetJoystickProperties - Get the properties associated with a joystick.

## HEADER FILE

Defined in SDL3/SDL\_joystick.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**SDL\_PropertiesID SDL\_GetJoystickProperties(SDL\_Joystick \*joystick);**

## DESCRIPTION

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

## FUNCTION PARAMETERS

- *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.

## AVAILABILITY

This function is available since SDL 3.2.0.