devela::_dep::sdl3::sys::hidapi

Function SDL_hid_set_nonblocking

pub unsafe extern "C" fn SDL_hid_set_nonblocking(
    dev: *mut SDL_hid_device,
    nonblock: i32,
) -> i32
Available on crate feature dep_sdl3 only.
Expand description

Set the device handle to be non-blocking.

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.

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