blob: b37f2cfe7fee4141697b3b5b3d5aa64d1fee7c08 [file] [log] [blame]
John Recke45b1fd2014-04-15 09:50:16 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Chris Craik5e00c7c2016-07-06 16:10:09 -070016
17#pragma once
John Recke45b1fd2014-04-15 09:50:16 -070018
Chris Craik0b7e8242015-10-28 16:50:44 -070019#include "utils/Macros.h"
John Reckc25e5062014-06-18 14:21:29 -070020
John Recke45b1fd2014-04-15 09:50:16 -070021#include <utils/Timers.h>
John Recke45b1fd2014-04-15 09:50:16 -070022
Chris Craik0b7e8242015-10-28 16:50:44 -070023#include <string>
John Recke4267ea2014-06-03 15:53:15 -070024
John Recke45b1fd2014-04-15 09:50:16 -070025namespace android {
26namespace uirenderer {
27
John Reck998a6d82014-08-28 15:35:53 -070028namespace renderthread {
29class CanvasContext;
30}
31
Tom Hudson2dc236b2014-10-15 15:46:42 -040032class DamageAccumulator;
Chris Craik0b7e8242015-10-28 16:50:44 -070033class LayerUpdateQueue;
John Reck44b49f02016-03-25 14:29:48 -070034class RenderNode;
John Reck3b202512014-06-23 13:13:08 -070035class RenderState;
John Recke45b1fd2014-04-15 09:50:16 -070036
John Reckc25e5062014-06-18 14:21:29 -070037class ErrorHandler {
38public:
39 virtual void onError(const std::string& message) = 0;
John Reck1bcacfd2017-11-03 10:12:19 -070040
John Reckc25e5062014-06-18 14:21:29 -070041protected:
42 ~ErrorHandler() {}
43};
44
John Reck44b49f02016-03-25 14:29:48 -070045class TreeObserver {
46public:
47 // Called when a RenderNode's parent count hits 0.
48 // Due to the unordered nature of tree pushes, once prepareTree
49 // is finished it is possible that the node was "resurrected" and has
50 // a non-zero parent count.
John Reck2de950d2017-01-25 10:58:30 -080051 virtual void onMaybeRemovedFromTree(RenderNode* node) = 0;
John Reck1bcacfd2017-11-03 10:12:19 -070052
John Reck44b49f02016-03-25 14:29:48 -070053protected:
John Reck2de950d2017-01-25 10:58:30 -080054 virtual ~TreeObserver() {}
John Reck44b49f02016-03-25 14:29:48 -070055};
56
John Recke4267ea2014-06-03 15:53:15 -070057// This would be a struct, but we want to PREVENT_COPY_AND_ASSIGN
58class TreeInfo {
59 PREVENT_COPY_AND_ASSIGN(TreeInfo);
John Reck1bcacfd2017-11-03 10:12:19 -070060
John Recke4267ea2014-06-03 15:53:15 -070061public:
62 enum TraversalMode {
63 // The full monty - sync, push, run animators, etc... Used by DrawFrameTask
64 // May only be used if both the UI thread and RT thread are blocked on the
65 // prepare
66 MODE_FULL,
67 // Run only what can be done safely on RT thread. Currently this only means
68 // animators, but potentially things like SurfaceTexture updates
69 // could be handled by this as well if there are no listeners
70 MODE_RT_ONLY,
John Recke4267ea2014-06-03 15:53:15 -070071 };
72
Chris Craike2e53a72015-10-28 15:55:40 -070073 TreeInfo(TraversalMode mode, renderthread::CanvasContext& canvasContext)
John Reck1bcacfd2017-11-03 10:12:19 -070074 : mode(mode), prepareTextures(mode == MODE_FULL), canvasContext(canvasContext) {}
John Reck68bfe0a2014-06-24 15:34:58 -070075
Skuhneea7a7fb2015-08-28 07:10:31 -070076 TraversalMode mode;
John Recke4267ea2014-06-03 15:53:15 -070077 // TODO: Remove this? Currently this is used to signal to stop preparing
78 // textures if we run out of cache space.
John Recke45b1fd2014-04-15 09:50:16 -070079 bool prepareTextures;
Chris Craike2e53a72015-10-28 15:55:40 -070080 renderthread::CanvasContext& canvasContext;
John Reck9eb9f6f2014-08-21 11:23:05 -070081 // TODO: buildLayer uses this to suppress running any animations, but this
82 // should probably be refactored somehow. The reason this is done is
83 // because buildLayer is not setup for injecting the animationHook, as well
84 // as this being otherwise wasted work as all the animators will be
85 // re-evaluated when the frame is actually drawn
Chris Craike2e53a72015-10-28 15:55:40 -070086 bool runAnimations = true;
Chris Craik69e5adf2014-08-14 13:34:01 -070087
88 // Must not be null during actual usage
Chris Craike2e53a72015-10-28 15:55:40 -070089 DamageAccumulator* damageAccumulator = nullptr;
Chris Craik0b7e8242015-10-28 16:50:44 -070090
Chris Craik0b7e8242015-10-28 16:50:44 -070091 LayerUpdateQueue* layerUpdateQueue = nullptr;
Chris Craike2e53a72015-10-28 15:55:40 -070092 ErrorHandler* errorHandler = nullptr;
John Reckf9be7792014-05-02 18:21:16 -070093
John Reckf6481082016-02-02 15:18:23 -080094 bool updateWindowPositions = false;
95
John Reckf9be7792014-05-02 18:21:16 -070096 struct Out {
Chris Craike2e53a72015-10-28 15:55:40 -070097 bool hasFunctors = false;
John Reckf9be7792014-05-02 18:21:16 -070098 // This is only updated if evaluateAnimations is true
Chris Craike2e53a72015-10-28 15:55:40 -070099 bool hasAnimations = false;
John Reckf9be7792014-05-02 18:21:16 -0700100 // This is set to true if there is an animation that RenderThread cannot
101 // animate itself, such as if hasFunctors is true
102 // This is only set if hasAnimations is true
Chris Craike2e53a72015-10-28 15:55:40 -0700103 bool requiresUiRedraw = false;
John Recka5dda642014-05-22 15:43:54 -0700104 // This is set to true if draw() can be called this frame
105 // false means that we must delay until the next vsync pulse as frame
106 // production is outrunning consumption
107 // NOTE that if this is false CanvasContext will set either requiresUiRedraw
108 // *OR* will post itself for the next vsync automatically, use this
109 // only to avoid calling draw()
Chris Craike2e53a72015-10-28 15:55:40 -0700110 bool canDrawThisFrame = true;
Leon Scroggins III4afdd1c2018-05-14 14:59:30 -0400111 // Sentinel for animatedImageDelay meaning there is no need to post such
112 // a message.
113 static constexpr nsecs_t kNoAnimatedImageDelay = -1;
114 // This is used to post a message to redraw when it is time to draw the
115 // next frame of an AnimatedImageDrawable.
116 nsecs_t animatedImageDelay = kNoAnimatedImageDelay;
John Reckf9be7792014-05-02 18:21:16 -0700117 } out;
John Recke45b1fd2014-04-15 09:50:16 -0700118
Stan Ilievdb45a4b2016-11-08 14:18:31 -0500119 // This flag helps to disable projection for receiver nodes that do not have any backward
120 // projected children.
121 bool hasBackwardProjectedNodes = false;
John Recke45b1fd2014-04-15 09:50:16 -0700122 // TODO: Damage calculations
123};
124
125} /* namespace uirenderer */
126} /* namespace android */