Semi-safe reference for HidDevice.
Inheritance diagram for SDL::HidDeviceRef:
Collaboration diagram for SDL::HidDeviceRef:
Public Member Functions | |
| HidDeviceRef (HidDeviceParam resource) | |
| Constructs from HidDeviceParam. More... | |
| HidDeviceRef (const HidDeviceRef &other) | |
| Copy constructor. | |
| ~HidDeviceRef () | |
| Destructor. | |
 Public Member Functions inherited from SDL::HidDevice | |
| constexpr | HidDevice ()=default |
| Default ctor. | |
| constexpr | HidDevice (const HidDeviceRaw resource) |
| Constructs from HidDeviceParam. More... | |
| constexpr | HidDevice (const HidDevice &other)=delete |
| Copy constructor. | |
| constexpr | HidDevice (HidDevice &&other) |
| Move constructor. | |
| constexpr | HidDevice (const HidDeviceRef &other)=delete |
| constexpr | HidDevice (HidDeviceRef &&other)=delete |
| HidDevice (unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) | |
| Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number. More... | |
| HidDevice (StringParam path) | |
| Open a HID device by its path name. More... | |
| ~HidDevice () | |
| Destructor. | |
| HidDevice & | operator= (HidDevice other) |
| Assignment operator. | |
| constexpr HidDeviceRaw | get () const |
| Retrieves underlying HidDeviceRaw. | |
| constexpr HidDeviceRaw | release () |
| Retrieves underlying HidDeviceRaw and clear this. | |
| constexpr auto | operator<=> (const HidDevice &other) const =default |
| Comparison. | |
| constexpr bool | operator== (std::nullptr_t _) const |
| Comparison. | |
| constexpr | operator bool () const |
| Converts to bool. | |
| constexpr | operator HidDeviceParam () const |
| Converts to HidDeviceParam. | |
| void | close () |
| Close a HID device. More... | |
| int | write (SourceBytes data) |
| Write an Output report to a HID device. More... | |
| int | read_timeout (TargetBytes data, Milliseconds timeout) |
| Read an Input report from a HID device with timeout. More... | |
| int | read (TargetBytes data) |
| Read an Input report from a HID device. More... | |
| void | set_nonblocking (bool nonblock) |
| Set the device handle to be non-blocking. More... | |
| int | send_feature_report (SourceBytes data) |
| Send a Feature report to the device. More... | |
| int | get_feature_report (TargetBytes data) |
| Get a feature report from a HID device. More... | |
| int | get_input_report (TargetBytes data) |
| Get an input report from a HID device. More... | |
| void | get_manufacturer_string (wchar_t *string, size_t maxlen) |
| Get The Manufacturer String from a HID device. More... | |
| void | get_product_string (wchar_t *string, size_t maxlen) |
| Get The Product String from a HID device. More... | |
| void | get_serial_number_string (wchar_t *string, size_t maxlen) |
| Get The Serial Number String from a HID device. More... | |
| void | get_indexed_string (int string_index, wchar_t *string, size_t maxlen) |
| Get a string from a HID device, based on its string index. More... | |
| hid_device_info * | get_device_info () |
| Get the device info from a HID device. More... | |
| int | get_report_descriptor (TargetBytes buf) |
| Get a report descriptor from a HID device. More... | |
Constructor & Destructor Documentation
◆ HidDeviceRef()
|
inline |
- Parameters
-
resource a HidDeviceRaw or HidDevice.
This does not takes ownership!
The documentation for this struct was generated from the following file:
- SDL3pp/SDL3pp_hidapi.h
