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

SDL_hid_set_nonblocking

Set the device handle to be non-blocking.

Header File

Syntax

int SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock);

Function Parameters

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

Return Value

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.0.0.

CategoryAPI, CategoryAPIFunction, CategoryHIDAPI