SDL_hid_set_nonblocking(3)

SDL_hid_set_nonblocking3

Set the device handle to be non-blocking.

Usage

#include "SDL3/SDL.h"

int SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock);

Header file

Defined in SDL3/SDL_hidapi.h

Overview

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.

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.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.