From 814146ae5938b50c1b3c5b088fe72d178589d4e8 Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Mon, 23 Feb 2026 17:05:00 +0100 Subject: [PATCH] add a caution regarding bSendImmediate and batching SendHaptics --- .../sghapticscomponent/README.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Handbook/src/advanced-topics/roll-your-own-hand-manipulation-system/sghapticscomponent/README.md b/Handbook/src/advanced-topics/roll-your-own-hand-manipulation-system/sghapticscomponent/README.md index 1d003f7c..3ee470e9 100644 --- a/Handbook/src/advanced-topics/roll-your-own-hand-manipulation-system/sghapticscomponent/README.md +++ b/Handbook/src/advanced-topics/roll-your-own-hand-manipulation-system/sghapticscomponent/README.md @@ -474,6 +474,16 @@ Queues a wrist-squeeze feedback at the desired level, and optionally if chosen, > - `0.0` = No squeeze. > - `1.0` = Full squeeze. +> [!CAUTION] +> Avoid using `SendImmediate` unless necessary. +> +> For optimal performance, queue all haptic commands first and call the +> `Send Haptics` function once after all commands are prepared. +> +> Sending commands immediately increases device communication frequency and +> computational overhead. Batching commands using `Send Haptics` reduces +> processing cost and improves performance. + **Returns:** - `true`: If queued successfully. @@ -535,3 +545,13 @@ This example demonstrates: ![SGHapticsComponent - Blueprint example: Wrist-squeeze](sghapticscomponent-blueprint-example-wrist-squeeze.png "SGHapticsComponent - Blueprint example: Wrist-squeeze") Because `bSendImmediate` is enabled, the squeeze is transmitted instantly instead of being queued. + +> [!CAUTION] +> Avoid using `SendImmediate` unless necessary. +> +> For optimal performance, queue all haptic commands first and call the +> `Send Haptics` function once after all commands are prepared. +> +> Sending commands immediately increases device communication frequency and +> computational overhead. Batching commands using `Send Haptics` reduces +> processing cost and improves performance.