---
name: "SDL_SetJoystickVirtualButton"
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_SetJoystickVirtualButton"
---

# SDL\_SetJoystickVirtualButton(3)

Set the state of a button on an opened virtual joystick.

## NAME

SDL\_SetJoystickVirtualButton - Set the state of a button on an opened virtual joystick.

## HEADER FILE

Defined in SDL3/SDL\_joystick.h

## SYNOPSIS

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

**bool SDL\_SetJoystickVirtualButton(SDL\_Joystick \*joystick, int button, bool down);**

## DESCRIPTION

Please note that values set here will not be applied until the next call to

**SDL\_UpdateJoysticks** , which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following:

**SDL\_PollEvent** ,  **SDL\_PumpEvents** ,

**SDL\_WaitEventTimeout** ,

**SDL\_WaitEvent** .

## FUNCTION PARAMETERS

- *joystick*

  the virtual joystick on which to set state.

- *button*

  the index of the button on the virtual joystick to update.

- *down*

  true if the button is pressed, false otherwise.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## AVAILABILITY

This function is available since SDL 3.2.0.