TreeInfo.h revision 3b20251a355c88193c439f928a84ae69483fb488 
1/*
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 */
16#ifndef TREEINFO_H
17#define TREEINFO_H
18
19#include <string>
20
21#include <utils/Timers.h>
22
23#include "DamageAccumulator.h"
24#include "utils/Macros.h"
25
26namespace android {
27namespace uirenderer {
28
29class BaseRenderNodeAnimator;
30class AnimationListener;
31class OpenGLRenderer;
32class RenderState;
33
34class AnimationHook {
35public:
36    virtual void callOnFinished(BaseRenderNodeAnimator* animator, AnimationListener* listener) = 0;
37protected:
38    ~AnimationHook() {}
39};
40
41class ErrorHandler {
42public:
43    virtual void onError(const std::string& message) = 0;
44protected:
45    ~ErrorHandler() {}
46};
47
48// This would be a struct, but we want to PREVENT_COPY_AND_ASSIGN
49class TreeInfo {
50    PREVENT_COPY_AND_ASSIGN(TreeInfo);
51public:
52    enum TraversalMode {
53        // The full monty - sync, push, run animators, etc... Used by DrawFrameTask
54        // May only be used if both the UI thread and RT thread are blocked on the
55        // prepare
56        MODE_FULL,
57        // Run only what can be done safely on RT thread. Currently this only means
58        // animators, but potentially things like SurfaceTexture updates
59        // could be handled by this as well if there are no listeners
60        MODE_RT_ONLY,
61        // The subtree is being detached. Maybe. If the RenderNode is present
62        // in both the old and new display list's children then it will get a
63        // MODE_MAYBE_DETACHING followed shortly by a MODE_FULL.
64        // Push any pending display list changes in case it is detached,
65        // but don't evaluate animators and such as if it isn't detached as a
66        // MODE_FULL will follow shortly.
67        MODE_MAYBE_DETACHING,
68        // TODO: TRIM_MEMORY?
69    };
70
71    explicit TreeInfo(TraversalMode mode, RenderState& renderState)
72        : mode(mode)
73        , frameTimeMs(0)
74        , animationHook(NULL)
75        , prepareTextures(mode == MODE_FULL)
76        , damageAccumulator(NullDamageAccumulator::instance())
77        , renderState(renderState)
78        , renderer(NULL)
79        , errorHandler(NULL)
80    {}
81
82    const TraversalMode mode;
83    nsecs_t frameTimeMs;
84    AnimationHook* animationHook;
85    // TODO: Remove this? Currently this is used to signal to stop preparing
86    // textures if we run out of cache space.
87    bool prepareTextures;
88    // Must not be null
89    IDamageAccumulator* damageAccumulator;
90    RenderState& renderState;
91    // The renderer that will be drawing the next frame. Use this to push any
92    // layer updates or similar. May be NULL.
93    OpenGLRenderer* renderer;
94    ErrorHandler* errorHandler;
95
96    struct Out {
97        Out()
98            : hasFunctors(false)
99            , hasAnimations(false)
100            , requiresUiRedraw(false)
101            , canDrawThisFrame(true)
102        {}
103        bool hasFunctors;
104        // This is only updated if evaluateAnimations is true
105        bool hasAnimations;
106        // This is set to true if there is an animation that RenderThread cannot
107        // animate itself, such as if hasFunctors is true
108        // This is only set if hasAnimations is true
109        bool requiresUiRedraw;
110        // This is set to true if draw() can be called this frame
111        // false means that we must delay until the next vsync pulse as frame
112        // production is outrunning consumption
113        // NOTE that if this is false CanvasContext will set either requiresUiRedraw
114        // *OR* will post itself for the next vsync automatically, use this
115        // only to avoid calling draw()
116        bool canDrawThisFrame;
117    } out;
118
119    // TODO: Damage calculations
120};
121
122} /* namespace uirenderer */
123} /* namespace android */
124
125#endif /* TREEINFO_H */
126