(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_hid_set_nonblocking

Set the device handle to be non-blocking.

Header File

Defined in <SDL3/SDL_hidapi.h>

Syntax

int SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock);

Function Parameters

SDL_hid_device *	dev	a device handle returned from SDL_hid_open().
int	nonblock	enable or not the nonblocking reads - 1 to enable nonblocking - 0 to disable nonblocking.

Return Value

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

Remarks

In non-blocking mode calls to SDL_hid_read() will return immediately with a value of 0 if there is no data to be read. In blocking mode, SDL_hid_read() will wait (block) until there is data to read before returning.

Nonblocking can be turned on and off at any time.

Version

This function is available since SDL 3.1.3.

---

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.