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

Function SDL_hid_enumerate

pub unsafe extern "C" fn SDL_hid_enumerate(
    vendor_id: u16,
    product_id: u16,
) -> *mut SDL_hid_device_info
Available on crate feature dep_sdl3 only.
Expand description

Enumerate the HID Devices.

This function returns a linked list of all the HID devices attached to the system which match vendor_id and product_id. If vendor_id is set to 0 then any vendor matches. If product_id is set to 0 then any product matches. If vendor_id and product_id are both set to 0, then all HID devices will be returned.

By default SDL will only enumerate controllers, to reduce risk of hanging or crashing on bad drivers, but [SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS] can be set to “0” to enumerate all HID devices.

§Parameters

  • vendor_id: the Vendor ID (VID) of the types of device to open, or 0 to match any vendor.
  • product_id: the Product ID (PID) of the types of device to open, or 0 to match any product.

§Return value

Returns a pointer to a linked list of type SDL_hid_device_info, containing information about the HID devices attached to the system, or NULL in the case of failure. Free this linked list by calling SDL_hid_free_enumeration().

§Availability

This function is available since SDL 3.2.0.

§See also