SDL_hid_get_input_report(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_hid_get_input_report ✨

okay bestie, so this one is a page from the SDL3 FUNCTIONS section of the manual, and it's all about the HID device life. SDL_hid_get_input_report — say it with me — it grabs an input report off a HID device. that's the whole vibe. 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_hidapi.h>

int SDL_hid_get_input_report(SDL_hid_device *dev, unsigned char *data, size_t length);

🌸 DESCRIPTION 🌸

ok so listen, this is the part where you have to be a little careful, no cap. 👑

Set the first byte of data to the Report ID of the report you wanna read. that's on you, bestie, the function will not do it for you. 🙈

And make sure you leave space for that extra byte in data — it's giving "surprise, there's an extra byte" but it's not a surprise, i told you. 💅

Upon return, the first byte will still contain the Report ID, and the actual report data will start in data[1]. so like, the report ID is main character energy and it's not moving out of slot zero. 🌟

💜 FUNCTION PARAMETERS 💜

  • dev — a device handle returned from SDL_hid_open(). you know, the little ticket that says "yes, this is my device." 🎟️
  • data — a buffer to put the read data into, including the Report ID. Set the first byte of data to the Report ID of the report to be read, or set it to zero if your device does not use numbered reports. 🫶
  • length — the number of bytes to read, including an extra byte for the report ID. and the tea is: the buffer can be longer than the actual report. so don't stress if you over-allocated, it's fine, she's flexible. ✨

🔥 RETURN VALUE 🔥

Returns the number of bytes read plus one for the report ID (which is still chilling in the first byte). 🥰

Or... -1 on on failure. 😭 and if that happens, call SDL_GetError() for more info, because she will tell you what went wrong. (and yes, the original says "on on failure" — we do not gatekeep, we do not edit, periodt.) 💀

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. so if you're on something older, bestie, you're simply not invited to this party. 🌈

and that's the whole page, you ate it up, no crumbs. 🍓 this lil beauty comes to you from Simple Directmedia Layer, version SDL 3.4.18, and it's filed under SDL_hid_get_input_report(3). mwah, go read the report. 💅🎀✨

📦 where this page comes from