• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Copyright (C) 2023 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//      http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15export type RedrawCallback = () => void;
16
17export interface Raf {
18  /**
19   * Schedule both a DOM and canvas redraw.
20   */
21  scheduleFullRedraw(): void;
22
23  /**
24   * Schedule a canvas redraw only.
25   */
26  scheduleCanvasRedraw(): void;
27
28  /**
29   * Add a callback for canvas redraws. `cb` will be called whenever a canvas
30   * redraw is scheduled canvas redraw using {@link scheduleCanvasRedraw()}.
31   *
32   * @param cb - The callback to called when canvas are redrawn.
33   * @returns - A disposable object that removes the callback when disposed.
34   */
35  addCanvasRedrawCallback(cb: RedrawCallback): Disposable;
36}
37