.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_hid_enumerate:
.\"   https://wiki.libsdl.org/SDL_hid_enumerate
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_hid_enumerate
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_hid_enumerate 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_hid_enumerate \- Enumerate the HID Devices\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_hid_device_info * SDL_hid_enumerate(unsigned short vendor_id, unsigned short product_id);
.fi
.SH DESCRIPTION
This function returns a linked list of all the HID devices attached to the
system which match vendor_id and product_id\[char46] If
.BR vendor_id
is set to 0
then any vendor matches\[char46] If
.BR product_id
is set to 0 then any product
matches\[char46] If
.BR vendor_id
and
.BR product_id
are both set to 0, then all HID
devices will be returned\[char46]

By default SDL will only enumerate controllers, to reduce risk of hanging
or crashing on bad drivers, but

.BR SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS

can be set to "0" to enumerate all HID devices\[char46]

.SH FUNCTION PARAMETERS
.TP
.I vendor_id
The Vendor ID (VID) of the types of device to open, or 0 to match any vendor\[char46]
.TP
.I product_id
The Product ID (PID) of the types of device to open, or 0 to match any product\[char46]
.SH RETURN VALUE
Returns a pointer to a linked list of type

.BR SDL_hid_device_info
, containing information about
the HID devices attached to the system, or NULL in the case of failure\[char46]
Free this linked list by calling

.BR SDL_hid_free_enumeration
()\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_hid_device_change_count (3)