You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

54 lines
4.0 KiB

  1. # ポインティングデバイス :id=pointing-device
  2. <!---
  3. original document: 0.9.43:docs/feature_pointing_device.md
  4. git diff 0.9.43 HEAD -- docs/feature_pointing_device.md | cat
  5. -->
  6. ポインティングデバイスは汎用的な機能の総称です: システムポインタを移動します。マウスキーのような他のオプションも確かにありますが、これは簡単に変更可能で軽量であることを目指しています。機能を制御するためにカスタムキーを実装したり、他の周辺機器から情報を収集してここに直接挿入したりできます - QMK に処理を任せてください。
  7. ポインティングデバイスを有効にするには、rules.mk の以下の行のコメントを解除します:
  8. ```makefile
  9. POINTING_DEVICE_ENABLE = yes
  10. ```
  11. マウスレポートを操作するために、以下の関数を使うことができます:
  12. * `pointing_device_get_report()` - ホストコンピュータに送信された情報を表す現在の report_mouse_t を返します。
  13. * `pointing_device_set_report(report_mouse_t newMouseReport)` - ホストコンピュータに送信される report_mouse_t を上書き保存します。
  14. report_mouse_t (ここでは "mouseReport") が以下のプロパティを持つことを覚えておいてください:
  15. * `mouseReport.x` - これは、x軸の動き(+ 右へ、- 左へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
  16. * `mouseReport.y` - これは、y軸の動き(+ 上へ、- 下へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
  17. * `mouseReport.v` - これは、垂直スクロール(+ 上へ、- 下へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
  18. * `mouseReport.h` - これは、水平スクロール(+ 右へ、- 左へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
  19. * `mouseReport.buttons` - これは uint8_t で、上位の5ビットを使っています。これらのビットはマウスボタンの状態を表します - ビット 3 はマウスボタン 5、ビット 7 はマウスボタン 1 です。
  20. マウスレポートに必要な変更を行ったら、それを送信する必要があります:
  21. * `pointing_device_send()` - マウスレポートをホストに送信し、レポートをゼロにします。
  22. マウスレポートが送信されると、x、y、v、h のいずれの値も 0 に設定されます (これは `pointing_device_send()` で行われます。この挙動を回避するためにオーバーライドすることができます)。このように、ボタンの状態は持続しますが、動きは1度だけ起こります。さらにカスタマイズするために、`pointing_device_init` と `pointing_device_task` のどちらもオーバーライドすることができます。
  23. 以下の例では、カスタムキーを使ってマウスをクリックし垂直および水平方向に127単位スクロールし、リリースされた時にそれを全て元に戻します - なぜならこれは完全に便利な機能だからです。いいですか、以下はひとつの例です:
  24. ```c
  25. case MS_SPECIAL:
  26. report_mouse_t currentReport = pointing_device_get_report();
  27. if (record->event.pressed) {
  28. currentReport.v = 127;
  29. currentReport.h = 127;
  30. currentReport.buttons |= MOUSE_BTN1; // this is defined in report.h
  31. } else {
  32. currentReport.v = -127;
  33. currentReport.h = -127;
  34. currentReport.buttons &= ~MOUSE_BTN1;
  35. }
  36. pointing_device_set_report(currentReport);
  37. pointing_device_send();
  38. break;
  39. ```
  40. マウスレポートは送信されるたびに 0 (ボタンを除く)に設定されることを思い出してください。そのため、スクロールはそれぞれの場合に1度だけ発生します。