SDL_hid_read_timeout - Read an Input report from a HID device with timeout.
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.10 SDL_hid_read_timeout(3)
Description
Input reports are returned to the host through the INTERRUPT IN endpoint. The first byte will contain
the Report number if the device uses numbered reports.
Function Parameters
dev a device handle returned from SDL_hid_open ().
data a buffer to put the read data into.
length the number of bytes to read. For devices with multiple reports, make sure to read an extra byte
for the report number.
milliseconds
timeout in milliseconds or -1 for blocking wait.
Header File
Defined in SDL3/SDL_hidapi.h
Name
SDL_hid_read_timeout - Read an Input report from a HID device with timeout.
Return Value
Returns the actual number of bytes read and -1 on on failure; call
SDL_GetError () for more information. If no packet was available to be read within the timeout period,
this function returns 0.
Synopsis
#include"SDL3/SDL.h"intSDL_hid_read_timeout(SDL_hid_device*dev,unsignedchar*data,size_tlength,intmilliseconds);
