(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_hid_read_timeout

Read an Input report from a HID device with timeout.

Header File

Defined in SDL_hidapi.h

Syntax

int SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds);

Function Parameters

SDL_hid_device *	dev	A device handle returned from SDL_hid_open().
unsigned char *	data	A buffer to put the read data into.
size_t	length	The number of bytes to read. For devices with multiple reports, make sure to read an extra byte for the report number.
int	milliseconds	timeout in milliseconds or -1 for blocking wait.

Return Value

(int) Returns the actual number of bytes read and -1 on error. If no packet was available to be read within the timeout period, this function returns 0.

Remarks

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.

Version

This function is available since SDL 2.0.18.

---

CategoryAPI, CategoryAPIFunction, CategoryHIDAPI

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.