summaryrefslogtreecommitdiffstats
path: root/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/CompositorController.java
blob: 77bca329c499a98052dde754f06c174767c94ca6 (plain)
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
121
122
123
124
125
126
127
128
129
130
131
132
133
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.geckoview;

import android.graphics.Color;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.UiThread;
import java.util.ArrayList;
import java.util.List;
import org.mozilla.gecko.annotation.RobocopTarget;
import org.mozilla.gecko.util.ThreadUtils;

@UiThread
public final class CompositorController {
  private final GeckoSession.Compositor mCompositor;

  private List<Runnable> mDrawCallbacks;
  private int mDefaultClearColor = Color.WHITE;
  private Runnable mFirstPaintCallback;

  /* package */ CompositorController(final GeckoSession session) {
    mCompositor = session.mCompositor;
  }

  /* package */ void onCompositorReady() {
    mCompositor.setDefaultClearColor(mDefaultClearColor);
    mCompositor.enableLayerUpdateNotifications(mDrawCallbacks != null && !mDrawCallbacks.isEmpty());
  }

  /* package */ void onCompositorDetached() {
    if (mDrawCallbacks != null) {
      mDrawCallbacks.clear();
    }
  }

  /* package */ void notifyDrawCallbacks() {
    if (mDrawCallbacks != null) {
      for (final Runnable callback : mDrawCallbacks) {
        callback.run();
      }
    }
  }

  /**
   * Add a callback to run when drawing (layer update) occurs.
   *
   * @param callback Callback to add.
   */
  @RobocopTarget
  public void addDrawCallback(final @NonNull Runnable callback) {
    ThreadUtils.assertOnUiThread();

    if (mDrawCallbacks == null) {
      mDrawCallbacks = new ArrayList<Runnable>(2);
    }

    if (mDrawCallbacks.add(callback) && mDrawCallbacks.size() == 1 && mCompositor.isReady()) {
      mCompositor.enableLayerUpdateNotifications(true);
    }
  }

  /**
   * Remove a previous draw callback.
   *
   * @param callback Callback to remove.
   */
  @RobocopTarget
  public void removeDrawCallback(final @NonNull Runnable callback) {
    ThreadUtils.assertOnUiThread();

    if (mDrawCallbacks == null) {
      return;
    }

    if (mDrawCallbacks.remove(callback) && mDrawCallbacks.isEmpty() && mCompositor.isReady()) {
      mCompositor.enableLayerUpdateNotifications(false);
    }
  }

  /**
   * Get the current clear color when drawing.
   *
   * @return Curent clear color.
   */
  public int getClearColor() {
    ThreadUtils.assertOnUiThread();
    return mDefaultClearColor;
  }

  /**
   * Set the clear color when drawing. Default is Color.WHITE.
   *
   * @param color Clear color.
   */
  public void setClearColor(final int color) {
    ThreadUtils.assertOnUiThread();

    mDefaultClearColor = color;
    if (mCompositor.isReady()) {
      mCompositor.setDefaultClearColor(mDefaultClearColor);
    }
  }

  /**
   * Get the current first paint callback.
   *
   * @return Current first paint callback or null if not set.
   */
  public @Nullable Runnable getFirstPaintCallback() {
    ThreadUtils.assertOnUiThread();
    return mFirstPaintCallback;
  }

  /**
   * Set a callback to run when a document is first drawn.
   *
   * @param callback First paint callback.
   */
  public void setFirstPaintCallback(final @Nullable Runnable callback) {
    ThreadUtils.assertOnUiThread();
    mFirstPaintCallback = callback;
  }

  /* package */ void onFirstPaint() {
    if (mFirstPaintCallback != null) {
      mFirstPaintCallback.run();
    }
  }
}