apply empty report rule to all encodings; comments added

2019-11-14 22:29:46 +01:00
parent f1f103850c
commit 57fe84508c
2 changed files with 11 additions and 4 deletions
@@ -249,5 +249,8 @@ export interface ICoreMouseProtocol {
 * The tracking encoding can be registered and activated at the CoreMouseService.
 * If a ICoreMouseEvent passes all procotol restrictions it will be encoded
 * with the active encoding and sent out.
+ * Note: Returning an empty string will supress sending a mouse report,
+ * which can be used to skip creating falsey reports in limited encodings
+ * (DEFAULT only supports up to 223 1-based as coord value).
 */
 export type CoreMouseEncoding = (event: ICoreMouseEvent) => string;