File: render_input_router.mojom

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 (120 lines) | stat: -rw-r--r-- 5,819 bytes parent folder | download | duplicates (5)
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

module input.mojom;

import "mojo/public/mojom/base/time.mojom";
import "mojo/public/mojom/base/unguessable_token.mojom";
import "services/viz/public/mojom/compositing/frame_sink_id.mojom";
import "third_party/blink/public/mojom/input/input_event_result.mojom";
import "third_party/blink/public/mojom/input/input_handler.mojom";
import "third_party/blink/public/mojom/widget/platform_widget.mojom";

// This struct is useful for sending information relevant to handling input on
// Viz from browser. This is only set when `InputOnViz` flag is enabled and a
// layer tree frame sink for renderer is being requested. Design doc for
// InputVizard project for moving touch input to viz on Android:
// https://docs.google.com/document/d/1mcydbkgFCO_TT9NuFE962L8PLJWT2XOfXUAPO88VuKE

struct RenderInputRouterConfig {
  pending_remote<blink.mojom.RenderInputRouterClient> rir_client;
  // This id allows Viz to use the same RenderWidgetHostInputEventRouter for
  // non-root layer tree frame sinks under the same WebContents in browser to
  // mirror 1:1 relationship between RenderWidgetHostInputEventRouter and
  // WebContentsImpl.
  mojo_base.mojom.UnguessableToken grouping_id;
  // Force zoom enable feature for accessbility.
  bool force_enable_zoom = false;
};

struct TouchTransferState {
  // Timestamp of the touch down event on which touch transfer was requested.
  // The value is obtained from |MotionEvent.getDownTime| Android API which
  // gives the timestamp in milliseconds.
  mojo_base.mojom.TimeTicks down_time_ms;

  // FrameSinkId of root widget which was being touched at the time of transfer.
  viz.mojom.FrameSinkId root_widget_frame_sink_id;

  // Y offset to be added to points received from Android to get coordinates
  // relative to root widget. This will be used to account for top controls
  // height when creating MotionEventAndroid on Viz side.
  float web_contents_y_offset_pix;

  // Device scale factor being used to create MotionEventAndroid objects for
  // converting device pixels to device independent pixels.
  float dip_scale;

  // A touch sequence that Browser would have handled, and should be returned to
  // Browser if it were a new sequence.
  // With Android 15 QPR2 update, the touches are always split across windows:
  // https://cs.android.com/android/_/android/platform/frameworks/native/+/a3fe664ce5d4931e2717a1ed48c8ea8e66b03ac8
  // What it means for Chrome is the pointer downs hit Browser process instead
  // of coming directly to Viz. They need to be transferred individually to Viz.
  bool browser_would_have_handled = false;
};

// Implemented by Viz, an interface between Browser and Viz. It defines methods
// used to communicate input event handling related state from Browser to Viz.
interface RenderInputRouterDelegate {
  // Send |TouchTransferState| from Browser upon a successful touch transfer.
  // Viz needs this to do input handling on it's side.
  StateOnTouchTransfer(TouchTransferState state);

  // Notifies RenderInputRouter corresponding to |frame_sink_id| on the
  // VizCompositor thread of changes to |force_enable_zoom| state for
  // Accessibility.
  ForceEnableZoomStateChanged(bool force_enable_zoom,
                              viz.mojom.FrameSinkId frame_sink_id);

  // Stops any ongoing flings for |frame_sink_id| on VizCompositorThread.
  StopFlingingOnViz(viz.mojom.FrameSinkId frame_sink_id);

  // Notifies RenderInputRouter on the VizCompositor thread (corresponding to
  // |frame_sink_id|) to restart its input event ack timer. This might be called
  // when the user has decided to wait in case of an unresponsive renderer or if
  // the renderer becomes visible again.
  RestartInputEventAckTimeoutIfNecessary(
    viz.mojom.FrameSinkId frame_sink_id);

  // Notifies RenderInputRouter on the VizCompositor thread (corresponding to
  // |frame_sink_id|) of any visibility changes to its corresponding page.
  NotifyVisibilityChanged(viz.mojom.FrameSinkId frame_sink_id, bool is_hidden);

  // Generates a synthetic touch cancel, which results in touch events being
  // dropped if there was an active touch sequence on Viz.
  ResetGestureDetection(viz.mojom.FrameSinkId root_widget_frame_sink_id);
};

// Implemented by the browser, this interface defines methods that will be
// invoked to keep the browser notified of input event handling on the
// VizCompositor thread.
interface RenderInputRouterDelegateClient {
  // Notifies InputEventObservers in the browser of input events being handled
  // on Viz (with InputVizard).
  NotifyObserversOfInputEvent(blink.mojom.Event event,
                              bool dispatched_to_renderer);

  // Notifies InputEventObservers in the browser of input event acks being
  // handled on Viz (with InputVizard).
  NotifyObserversOfInputEventAcks(blink.mojom.InputEventResultSource ack_source,
      blink.mojom.InputEventResultState ack_result, blink.mojom.Event event);

  // Notifies the browser of an invalid input event source being seen on
  // the VizCompositor thread when handling input.
  OnInvalidInputEventSource();

  // Sends |DidOverscrollParams| to the browser to allow overscroll effect to
  // request input back if it ends up consuming the input sequence.
  StateOnOverscrollTransfer(
    blink.mojom.DidOverscrollParams? overscroll);

  // Notifies browser that the renderer is responsive after being unresponsive
  // or has turned unresonsive to input events. For the latter, it also passes
  // over the timestamp when an input event timed out without getting an ack
  // from the renderer.
  RendererInputResponsivenessChanged(
    bool is_responsive,
    mojo_base.mojom.TimeTicks? ack_timeout_ts);
};