table of contents
SDL_hid_read_timeout(3) | SDL3 FUNCTIONS | SDL_hid_read_timeout(3) |
NAME¶
SDL_hid_read_timeout - Read an Input report from a HID device with timeout.
HEADER FILE¶
Defined in SDL3/SDL_hidapi.h
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds);
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.
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.
AVAILABILITY¶
This function is available since SDL 3.1.3.
SDL 3.1.6 | Simple Directmedia Layer |