(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SendJoystickVirtualSensorData

Send a sensor update for an opened virtual joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

int SDL_SendJoystickVirtualSensorData(SDL_Joystick *joystick, SDL_SensorType type, Uint64 sensor_timestamp, const float *data, int num_values);

Function Parameters

joystick the virtual joystick on which to set state.
type the type of the sensor on the virtual joystick to update.
sensor_timestamp a 64-bit timestamp in nanoseconds associated with the sensor reading
data the data associated with the sensor reading
num_values the number of values pointed to by data

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryJoystick