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