File: haptics_util.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (41 lines) | stat: -rw-r--r-- 1,580 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROMEOS_UTILS_HAPTICS_UTIL_H_
#define CHROMEOS_UTILS_HAPTICS_UTIL_H_

#include "base/component_export.h"

namespace ui {
class InputController;
enum class HapticTouchpadEffect;
enum class HapticTouchpadEffectStrength;
}  // namespace ui

// Utility that provides methods to trigger haptic effects throughout Ash.
// These call `InputController` functions that will play the effects if a haptic
// touchpad is available.
namespace chromeos::haptics_util {

// Sets test input controller for testing. When `g_test_input_controller1 is not
// nullptr, `PlayHapticTouchpadEffect()` will call the test controller instead
// of the real one from ozone.
COMPONENT_EXPORT(CHROMEOS_UTILS) void SetInputControllerForTesting(
    ui::InputController* input_controller);

// Plays a touchpad haptic feedback effect according to the given `effect` type,
// and the given `strength`. By default it uses ozone's input controller, unless
// it was overridden by the above `SetInputControllerForTesting()`.
COMPONENT_EXPORT(CHROMEOS_UTILS) void PlayHapticTouchpadEffect(
    ui::HapticTouchpadEffect effect,
    ui::HapticTouchpadEffectStrength strength);

// Plays a `ToggleOn` or `ToggleOff` haptic effect based on the `on` bool value.
COMPONENT_EXPORT(CHROMEOS_UTILS) void PlayHapticToggleEffect(
    bool on,
    ui::HapticTouchpadEffectStrength strength);

}  // namespace chromeos::haptics_util

#endif  // CHROMEOS_UTILS_HAPTICS_UTIL_H_