NAME

SDL_SetJoystickVirtualHat - Set the state of a hat on an opened virtual joystick.

SYNOPSIS

#include <SDL3/SDL_joystick.h>

bool SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value);

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.

hat

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

value

the new value for the specified hat.

RETURN VALUE

Returns true on success or false on failure; call SDL_GetError() for more information.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

SDL_SetJoystickVirtualAxis(3), SDL_SetJoystickVirtualButton(3), SDL_SetJoystickVirtualBall(3), SDL_SetJoystickVirtualTouchpad(3), SDL_SetJoystickVirtualSensorData(3)