NAME¶

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

HEADER FILE¶

Defined in SDL3/SDL_joystick.h

SYNOPSIS¶

#include "SDL3/SDL.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.

AVAILABILITY¶

This function is available since SDL 3.1.3.