RenderNode.h revision 2218472d23483f09341bf655d55db21dcbabc1b6 
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 RENDERNODE_H
17#define RENDERNODE_H
18
19#ifndef LOG_TAG
20    #define LOG_TAG "OpenGLRenderer"
21#endif
22
23#include <set>
24#include <vector>
25
26#include <SkCamera.h>
27#include <SkMatrix.h>
28
29#include <private/hwui/DrawGlInfo.h>
30
31#include <utils/KeyedVector.h>
32#include <utils/LinearAllocator.h>
33#include <utils/RefBase.h>
34#include <utils/SortedVector.h>
35#include <utils/String8.h>
36#include <utils/Vector.h>
37
38#include <cutils/compiler.h>
39
40#include <androidfw/ResourceTypes.h>
41
42#include "DamageAccumulator.h"
43#include "Debug.h"
44#include "Matrix.h"
45#include "DeferredDisplayList.h"
46#include "DisplayList.h"
47#include "RenderProperties.h"
48#include "TreeInfo.h"
49
50class SkBitmap;
51class SkPaint;
52class SkPath;
53class SkRegion;
54
55namespace android {
56namespace uirenderer {
57
58class DeferredDisplayList;
59class DisplayListOp;
60class DisplayListRenderer;
61class OpenGLRenderer;
62class Rect;
63class Layer;
64class SkiaShader;
65
66class ClipRectOp;
67class SaveLayerOp;
68class SaveOp;
69class RestoreToCountOp;
70class DrawDisplayListOp;
71
72/**
73 * Primary class for storing recorded canvas commands, as well as per-View/ViewGroup display properties.
74 *
75 * Recording of canvas commands is somewhat similar to SkPicture, except the canvas-recording
76 * functionality is split between DisplayListRenderer (which manages the recording), DisplayListData
77 * (which holds the actual data), and DisplayList (which holds properties and performs playback onto
78 * a renderer).
79 *
80 * Note that DisplayListData is swapped out from beneath an individual DisplayList when a view's
81 * recorded stream of canvas operations is refreshed. The DisplayList (and its properties) stay
82 * attached.
83 */
84class RenderNode : public VirtualLightRefBase {
85public:
86    enum DirtyPropertyMask {
87        GENERIC         = 1 << 1,
88        TRANSLATION_X   = 1 << 2,
89        TRANSLATION_Y   = 1 << 3,
90        TRANSLATION_Z   = 1 << 4,
91        SCALE_X         = 1 << 5,
92        SCALE_Y         = 1 << 6,
93        ROTATION        = 1 << 7,
94        ROTATION_X      = 1 << 8,
95        ROTATION_Y      = 1 << 9,
96        X               = 1 << 10,
97        Y               = 1 << 11,
98        Z               = 1 << 12,
99        ALPHA           = 1 << 13,
100    };
101
102    ANDROID_API RenderNode();
103    ANDROID_API virtual ~RenderNode();
104
105    // See flags defined in DisplayList.java
106    enum ReplayFlag {
107        kReplayFlag_ClipChildren = 0x1
108    };
109
110    ANDROID_API static void outputLogBuffer(int fd);
111
112    ANDROID_API void setStagingDisplayList(DisplayListData* newData);
113
114    void computeOrdering();
115
116    void deferNodeTree(DeferStateStruct& deferStruct);
117    void deferNodeInParent(DeferStateStruct& deferStruct, const int level);
118
119    void replayNodeTree(ReplayStateStruct& replayStruct);
120    void replayNodeInParent(ReplayStateStruct& replayStruct, const int level);
121
122    ANDROID_API void output(uint32_t level = 1);
123    ANDROID_API int getDebugSize();
124
125    bool isRenderable() const {
126        return mDisplayListData && mDisplayListData->hasDrawOps;
127    }
128
129    bool hasProjectionReceiver() const {
130        return mDisplayListData && mDisplayListData->projectionReceiveIndex >= 0;
131    }
132
133    const char* getName() const {
134        return mName.string();
135    }
136
137    void setName(const char* name) {
138        if (name) {
139            char* lastPeriod = strrchr(name, '.');
140            if (lastPeriod) {
141                mName.setTo(lastPeriod + 1);
142            } else {
143                mName.setTo(name);
144            }
145        }
146    }
147
148    bool isPropertyFieldDirty(DirtyPropertyMask field) const {
149        return mDirtyPropertyFields & field;
150    }
151
152    void setPropertyFieldsDirty(uint32_t fields) {
153        mDirtyPropertyFields |= fields;
154    }
155
156    const RenderProperties& properties() const {
157        return mProperties;
158    }
159
160    RenderProperties& animatorProperties() {
161        return mProperties;
162    }
163
164    const RenderProperties& stagingProperties() {
165        return mStagingProperties;
166    }
167
168    RenderProperties& mutateStagingProperties() {
169        return mStagingProperties;
170    }
171
172    int getWidth() {
173        return properties().getWidth();
174    }
175
176    int getHeight() {
177        return properties().getHeight();
178    }
179
180    ANDROID_API virtual void prepareTree(TreeInfo& info);
181
182    // UI thread only!
183    ANDROID_API void addAnimator(const sp<BaseRenderNodeAnimator>& animator) {
184        animator->onAttached(this);
185        mStagingAnimators.insert(animator);
186        mNeedsAnimatorsSync = true;
187    }
188
189    // UI thread only!
190    ANDROID_API void removeAnimator(const sp<BaseRenderNodeAnimator>& animator) {
191        mStagingAnimators.erase(animator);
192        // Force a sync of the staging property value
193        mDirtyPropertyFields |= animator->dirtyMask();
194        mNeedsAnimatorsSync = true;
195    }
196
197protected:
198    virtual void damageSelf(TreeInfo& info);
199
200private:
201    typedef key_value_pair_t<float, DrawDisplayListOp*> ZDrawDisplayListOpPair;
202
203    static size_t findNonNegativeIndex(const Vector<ZDrawDisplayListOpPair>& nodes) {
204        for (size_t i = 0; i < nodes.size(); i++) {
205            if (nodes[i].key >= 0.0f) return i;
206        }
207        return nodes.size();
208    }
209
210    enum ChildrenSelectMode {
211        kNegativeZChildren,
212        kPositiveZChildren
213    };
214
215    void applyViewPropertyTransforms(mat4& matrix, bool true3dTransform = false);
216
217    void computeOrderingImpl(DrawDisplayListOp* opState,
218            const SkPath* outlineOfProjectionSurface,
219            Vector<DrawDisplayListOp*>* compositedChildrenOfProjectionSurface,
220            const mat4* transformFromProjectionSurface);
221
222    template <class T>
223    inline void setViewProperties(OpenGLRenderer& renderer, T& handler);
224
225    void buildZSortedChildList(Vector<ZDrawDisplayListOpPair>& zTranslatedNodes);
226
227    template<class T>
228    inline void issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler);
229
230    template <class T>
231    inline void issueOperationsOf3dChildren(const Vector<ZDrawDisplayListOpPair>& zTranslatedNodes,
232            ChildrenSelectMode mode, OpenGLRenderer& renderer, T& handler);
233
234    template <class T>
235    inline void issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler);
236
237    /**
238     * Issue the RenderNode's operations into a handler, recursing for subtrees through
239     * DrawDisplayListOp's defer() or replay() methods
240     */
241    template <class T>
242    inline void issueOperations(OpenGLRenderer& renderer, T& handler);
243
244    class TextContainer {
245    public:
246        size_t length() const {
247            return mByteLength;
248        }
249
250        const char* text() const {
251            return (const char*) mText;
252        }
253
254        size_t mByteLength;
255        const char* mText;
256    };
257
258    void prepareTreeImpl(TreeInfo& info);
259    void pushStagingPropertiesChanges(TreeInfo& info);
260    void pushStagingDisplayListChanges(TreeInfo& info);
261    void evaluateAnimations(TreeInfo& info);
262    void prepareSubTree(TreeInfo& info, DisplayListData* subtree);
263    void applyLayerPropertiesToLayer(TreeInfo& info);
264    void prepareLayer(TreeInfo& info);
265    void pushLayerUpdate(TreeInfo& info);
266
267    String8 mName;
268
269    uint32_t mDirtyPropertyFields;
270    RenderProperties mProperties;
271    RenderProperties mStagingProperties;
272
273    bool mNeedsDisplayListDataSync;
274    DisplayListData* mDisplayListData;
275    DisplayListData* mStagingDisplayListData;
276
277    bool mNeedsAnimatorsSync;
278    std::set< sp<BaseRenderNodeAnimator> > mStagingAnimators;
279    std::vector< sp<BaseRenderNodeAnimator> > mAnimators;
280
281    // Owned by RT. Lifecycle is managed by prepareTree(), with the exception
282    // being in ~RenderNode() which may happen on any thread.
283    Layer* mLayer;
284
285    /**
286     * Draw time state - these properties are only set and used during rendering
287     */
288
289    // for projection surfaces, contains a list of all children items
290    Vector<DrawDisplayListOp*> mProjectedNodes;
291}; // class RenderNode
292
293} /* namespace uirenderer */
294} /* namespace android */
295
296#endif /* RENDERNODE_H */
297