NAME¶

SDL_hid_enumerate - Enumerate the HID Devices.

HEADER FILE¶

Defined in SDL3/SDL_hidapi.h

SYNOPSIS¶

#include "SDL3/SDL.h"

SDL_hid_device_info * SDL_hid_enumerate(unsigned short vendor_id, unsigned short product_id);

DESCRIPTION¶

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.

FUNCTION 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¶

( SDL_hid_device_info
*) 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.1.3.

SEE ALSO¶

•(3), SDL_hid_device_change_count(3)