chore: 添加 touch 系列接口注释

MaaXYZ · Sep 21, 2024 · ddd2eab · ddd2eab
1 parent 6bac4e7
commit ddd2eab
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/include/MaaFramework/Instance/MaaController.h b/include/MaaFramework/Instance/MaaController.h
@@ -57,8 +57,11 @@ extern "C"
     /**
      * @param[in] value
      */
-    MAA_FRAMEWORK_API MaaBool
-        MaaControllerSetOption(MaaController* ctrl, MaaCtrlOption key, MaaOptionValue value /**< byte array, int*, char*, bool* */, MaaOptionValueSize val_size);
+    MAA_FRAMEWORK_API MaaBool MaaControllerSetOption(
+        MaaController* ctrl,
+        MaaCtrlOption key,
+        MaaOptionValue value /**< byte array, int*, char*, bool* */,
+        MaaOptionValueSize val_size);
 
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostConnection(MaaController* ctrl);
 
@@ -75,10 +78,14 @@ extern "C"
 
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostStopApp(MaaController* ctrl, const char* intent);
 
+    // for adb controller, contact means finger id (0 for first finger, 1 for second finger, etc)
+    // for win32 controller, contact means mouse button id (0 for left, 1 for right, 2 for middle)
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchDown(MaaController* ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);
-    
+
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchMove(MaaController* ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);
 
+    // for adb controller, contact means finger id (0 for first finger, 1 for second finger, etc)
+    // for win32 controller, contact means mouse button id (0 for left, 1 for right, 2 for middle)
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchUp(MaaController* ctrl, int32_t contact);
 
     MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostScreencap(MaaController* ctrl);