目次 - SDL 3.0 API(機能別) - HIDAPI - SDL_hid_get_input_report

SDL_hid_get_input_report

HIDデバイスから入力レポートを得る

ヘッダ

SDL3/SDL_hidapi.h

構文

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

引数

SDL_hid_device *devSDL_hid_open()が戻したデバイスハンドル
unsigned char *dataレポートIDを含む読み込んだデータの書き込み先のバッファ. dataの先頭バイトには, 読み込むレポートのレポートID, またはデバイスが番号付きのレポートを使用しない場合は0を設定すること
size_tlengthレポートIDを含む読み込むバイト数. バッファは実際のレポートよりも長くてもよい

戻り値

(int) 受信したバイト数+レポートIDの1バイト(これはまだ先頭バイトにある)を戻す. 失敗のとき-1を戻す. SDL_GetError()で詳細を知ることができる.

詳細

dataの先頭バイトには, 読み込むレポートのレポートIDを設定する. dataはこの追加のバイトを含めて確保すること. 関数から戻ったとき, 先頭のレポートIDは残ったままであり, レポートデータはdata[1]から始まる.

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_hid_get_input_report - SDL Wiki