RenderNode.cpp revision 3d4eed7f1aa99401dabe2e45b82f98fb4fc2d754
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 17#define ATRACE_TAG ATRACE_TAG_VIEW 18#define LOG_TAG "OpenGLRenderer" 19 20#include "RenderNode.h" 21 22#include <algorithm> 23#include <string> 24 25#include <SkCanvas.h> 26#include <algorithm> 27 28 29#include "DamageAccumulator.h" 30#include "Debug.h" 31#include "DisplayListOp.h" 32#include "DisplayListLogBuffer.h" 33#include "LayerRenderer.h" 34#include "OpenGLRenderer.h" 35#include "TreeInfo.h" 36#include "utils/MathUtils.h" 37#include "utils/TraceUtils.h" 38#include "renderthread/CanvasContext.h" 39 40namespace android { 41namespace uirenderer { 42 43void RenderNode::outputLogBuffer(int fd) { 44 DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance(); 45 if (logBuffer.isEmpty()) { 46 return; 47 } 48 49 FILE *file = fdopen(fd, "a"); 50 51 fprintf(file, "\nRecent DisplayList operations\n"); 52 logBuffer.outputCommands(file); 53 54 if (Caches::hasInstance()) { 55 String8 cachesLog; 56 Caches::getInstance().dumpMemoryUsage(cachesLog); 57 fprintf(file, "\nCaches:\n%s\n", cachesLog.string()); 58 } else { 59 fprintf(file, "\nNo caches instance.\n"); 60 } 61 62 fflush(file); 63} 64 65void RenderNode::debugDumpLayers(const char* prefix) { 66 if (mLayer) { 67 ALOGD("%sNode %p (%s) has layer %p (fbo = %u, wasBuildLayered = %s)", 68 prefix, this, getName(), mLayer, mLayer->getFbo(), 69 mLayer->wasBuildLayered ? "true" : "false"); 70 } 71 if (mDisplayListData) { 72 for (size_t i = 0; i < mDisplayListData->children().size(); i++) { 73 mDisplayListData->children()[i]->mRenderNode->debugDumpLayers(prefix); 74 } 75 } 76} 77 78RenderNode::RenderNode() 79 : mDirtyPropertyFields(0) 80 , mNeedsDisplayListDataSync(false) 81 , mDisplayListData(nullptr) 82 , mStagingDisplayListData(nullptr) 83 , mAnimatorManager(*this) 84 , mLayer(nullptr) 85 , mParentCount(0) { 86} 87 88RenderNode::~RenderNode() { 89 deleteDisplayListData(); 90 delete mStagingDisplayListData; 91 if (mLayer) { 92 ALOGW("Memory Warning: Layer %p missed its detachment, held on to for far too long!", mLayer); 93 mLayer->postDecStrong(); 94 mLayer = nullptr; 95 } 96} 97 98void RenderNode::setStagingDisplayList(DisplayListData* data) { 99 mNeedsDisplayListDataSync = true; 100 delete mStagingDisplayListData; 101 mStagingDisplayListData = data; 102} 103 104/** 105 * This function is a simplified version of replay(), where we simply retrieve and log the 106 * display list. This function should remain in sync with the replay() function. 107 */ 108void RenderNode::output(uint32_t level) { 109 ALOGD("%*sStart display list (%p, %s%s%s%s)", (level - 1) * 2, "", this, 110 getName(), 111 (properties().hasShadow() ? ", casting shadow" : ""), 112 (isRenderable() ? "" : ", empty"), 113 (mLayer != nullptr ? ", on HW Layer" : "")); 114 ALOGD("%*s%s %d", level * 2, "", "Save", 115 SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag); 116 117 properties().debugOutputProperties(level); 118 int flags = DisplayListOp::kOpLogFlag_Recurse; 119 if (mDisplayListData) { 120 // TODO: consider printing the chunk boundaries here 121 for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) { 122 mDisplayListData->displayListOps[i]->output(level, flags); 123 } 124 } 125 126 ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, getName()); 127} 128 129int RenderNode::getDebugSize() { 130 int size = sizeof(RenderNode); 131 if (mStagingDisplayListData) { 132 size += mStagingDisplayListData->getUsedSize(); 133 } 134 if (mDisplayListData && mDisplayListData != mStagingDisplayListData) { 135 size += mDisplayListData->getUsedSize(); 136 } 137 return size; 138} 139 140void RenderNode::prepareTree(TreeInfo& info) { 141 ATRACE_CALL(); 142 LOG_ALWAYS_FATAL_IF(!info.damageAccumulator, "DamageAccumulator missing"); 143 144 prepareTreeImpl(info); 145} 146 147void RenderNode::addAnimator(const sp<BaseRenderNodeAnimator>& animator) { 148 mAnimatorManager.addAnimator(animator); 149} 150 151void RenderNode::damageSelf(TreeInfo& info) { 152 if (isRenderable()) { 153 if (properties().getClipDamageToBounds()) { 154 info.damageAccumulator->dirty(0, 0, properties().getWidth(), properties().getHeight()); 155 } else { 156 // Hope this is big enough? 157 // TODO: Get this from the display list ops or something 158 info.damageAccumulator->dirty(INT_MIN, INT_MIN, INT_MAX, INT_MAX); 159 } 160 } 161} 162 163void RenderNode::prepareLayer(TreeInfo& info, uint32_t dirtyMask) { 164 LayerType layerType = properties().layerProperties().type(); 165 if (CC_UNLIKELY(layerType == kLayerTypeRenderLayer)) { 166 // Damage applied so far needs to affect our parent, but does not require 167 // the layer to be updated. So we pop/push here to clear out the current 168 // damage and get a clean state for display list or children updates to 169 // affect, which will require the layer to be updated 170 info.damageAccumulator->popTransform(); 171 info.damageAccumulator->pushTransform(this); 172 if (dirtyMask & DISPLAY_LIST) { 173 damageSelf(info); 174 } 175 } 176} 177 178void RenderNode::pushLayerUpdate(TreeInfo& info) { 179 LayerType layerType = properties().layerProperties().type(); 180 // If we are not a layer OR we cannot be rendered (eg, view was detached) 181 // we need to destroy any Layers we may have had previously 182 if (CC_LIKELY(layerType != kLayerTypeRenderLayer) || CC_UNLIKELY(!isRenderable())) { 183 if (CC_UNLIKELY(mLayer)) { 184 LayerRenderer::destroyLayer(mLayer); 185 mLayer = nullptr; 186 } 187 return; 188 } 189 190 bool transformUpdateNeeded = false; 191 if (!mLayer) { 192 mLayer = LayerRenderer::createRenderLayer(info.renderState, getWidth(), getHeight()); 193 applyLayerPropertiesToLayer(info); 194 damageSelf(info); 195 transformUpdateNeeded = true; 196 } else if (mLayer->layer.getWidth() != getWidth() || mLayer->layer.getHeight() != getHeight()) { 197 if (!LayerRenderer::resizeLayer(mLayer, getWidth(), getHeight())) { 198 LayerRenderer::destroyLayer(mLayer); 199 mLayer = nullptr; 200 } 201 damageSelf(info); 202 transformUpdateNeeded = true; 203 } 204 205 SkRect dirty; 206 info.damageAccumulator->peekAtDirty(&dirty); 207 208 if (!mLayer) { 209 Caches::getInstance().dumpMemoryUsage(); 210 if (info.errorHandler) { 211 std::string msg = "Unable to create layer for "; 212 msg += getName(); 213 info.errorHandler->onError(msg); 214 } 215 return; 216 } 217 218 if (transformUpdateNeeded) { 219 // update the transform in window of the layer to reset its origin wrt light source position 220 Matrix4 windowTransform; 221 info.damageAccumulator->computeCurrentTransform(&windowTransform); 222 mLayer->setWindowTransform(windowTransform); 223 } 224 225 if (dirty.intersect(0, 0, getWidth(), getHeight())) { 226 dirty.roundOut(&dirty); 227 mLayer->updateDeferred(this, dirty.fLeft, dirty.fTop, dirty.fRight, dirty.fBottom); 228 } 229 // This is not inside the above if because we may have called 230 // updateDeferred on a previous prepare pass that didn't have a renderer 231 if (info.renderer && mLayer->deferredUpdateScheduled) { 232 info.renderer->pushLayerUpdate(mLayer); 233 } 234 235 if (CC_UNLIKELY(info.canvasContext)) { 236 // If canvasContext is not null that means there are prefetched layers 237 // that need to be accounted for. That might be us, so tell CanvasContext 238 // that this layer is in the tree and should not be destroyed. 239 info.canvasContext->markLayerInUse(this); 240 } 241} 242 243void RenderNode::prepareTreeImpl(TreeInfo& info) { 244 info.damageAccumulator->pushTransform(this); 245 246 if (info.mode == TreeInfo::MODE_FULL) { 247 pushStagingPropertiesChanges(info); 248 } 249 uint32_t animatorDirtyMask = 0; 250 if (CC_LIKELY(info.runAnimations)) { 251 animatorDirtyMask = mAnimatorManager.animate(info); 252 } 253 prepareLayer(info, animatorDirtyMask); 254 if (info.mode == TreeInfo::MODE_FULL) { 255 pushStagingDisplayListChanges(info); 256 } 257 prepareSubTree(info, mDisplayListData); 258 pushLayerUpdate(info); 259 260 info.damageAccumulator->popTransform(); 261} 262 263void RenderNode::pushStagingPropertiesChanges(TreeInfo& info) { 264 // Push the animators first so that setupStartValueIfNecessary() is called 265 // before properties() is trampled by stagingProperties(), as they are 266 // required by some animators. 267 if (CC_LIKELY(info.runAnimations)) { 268 mAnimatorManager.pushStaging(); 269 } 270 if (mDirtyPropertyFields) { 271 mDirtyPropertyFields = 0; 272 damageSelf(info); 273 info.damageAccumulator->popTransform(); 274 mProperties = mStagingProperties; 275 applyLayerPropertiesToLayer(info); 276 // We could try to be clever and only re-damage if the matrix changed. 277 // However, we don't need to worry about that. The cost of over-damaging 278 // here is only going to be a single additional map rect of this node 279 // plus a rect join(). The parent's transform (and up) will only be 280 // performed once. 281 info.damageAccumulator->pushTransform(this); 282 damageSelf(info); 283 } 284} 285 286void RenderNode::applyLayerPropertiesToLayer(TreeInfo& info) { 287 if (CC_LIKELY(!mLayer)) return; 288 289 const LayerProperties& props = properties().layerProperties(); 290 mLayer->setAlpha(props.alpha(), props.xferMode()); 291 mLayer->setColorFilter(props.colorFilter()); 292 mLayer->setBlend(props.needsBlending()); 293} 294 295void RenderNode::pushStagingDisplayListChanges(TreeInfo& info) { 296 if (mNeedsDisplayListDataSync) { 297 mNeedsDisplayListDataSync = false; 298 // Make sure we inc first so that we don't fluctuate between 0 and 1, 299 // which would thrash the layer cache 300 if (mStagingDisplayListData) { 301 for (size_t i = 0; i < mStagingDisplayListData->children().size(); i++) { 302 mStagingDisplayListData->children()[i]->mRenderNode->incParentRefCount(); 303 } 304 } 305 // Damage with the old display list first then the new one to catch any 306 // changes in isRenderable or, in the future, bounds 307 damageSelf(info); 308 deleteDisplayListData(); 309 // TODO: Remove this caches stuff 310 if (mStagingDisplayListData && mStagingDisplayListData->functors.size()) { 311 Caches::getInstance().registerFunctors(mStagingDisplayListData->functors.size()); 312 } 313 mDisplayListData = mStagingDisplayListData; 314 mStagingDisplayListData = nullptr; 315 if (mDisplayListData) { 316 for (size_t i = 0; i < mDisplayListData->functors.size(); i++) { 317 (*mDisplayListData->functors[i])(DrawGlInfo::kModeSync, nullptr); 318 } 319 } 320 damageSelf(info); 321 } 322} 323 324void RenderNode::deleteDisplayListData() { 325 if (mDisplayListData) { 326 for (size_t i = 0; i < mDisplayListData->children().size(); i++) { 327 mDisplayListData->children()[i]->mRenderNode->decParentRefCount(); 328 } 329 if (mDisplayListData->functors.size()) { 330 Caches::getInstance().unregisterFunctors(mDisplayListData->functors.size()); 331 } 332 } 333 delete mDisplayListData; 334 mDisplayListData = nullptr; 335} 336 337void RenderNode::prepareSubTree(TreeInfo& info, DisplayListData* subtree) { 338 if (subtree) { 339 TextureCache& cache = Caches::getInstance().textureCache; 340 info.out.hasFunctors |= subtree->functors.size(); 341 for (size_t i = 0; info.prepareTextures && i < subtree->bitmapResources.size(); i++) { 342 info.prepareTextures = cache.prefetchAndMarkInUse(subtree->bitmapResources[i]); 343 } 344 for (size_t i = 0; i < subtree->children().size(); i++) { 345 DrawRenderNodeOp* op = subtree->children()[i]; 346 RenderNode* childNode = op->mRenderNode; 347 info.damageAccumulator->pushTransform(&op->mTransformFromParent); 348 childNode->prepareTreeImpl(info); 349 info.damageAccumulator->popTransform(); 350 } 351 } 352} 353 354void RenderNode::destroyHardwareResources() { 355 if (mLayer) { 356 LayerRenderer::destroyLayer(mLayer); 357 mLayer = nullptr; 358 } 359 if (mDisplayListData) { 360 for (size_t i = 0; i < mDisplayListData->children().size(); i++) { 361 mDisplayListData->children()[i]->mRenderNode->destroyHardwareResources(); 362 } 363 if (mNeedsDisplayListDataSync) { 364 // Next prepare tree we are going to push a new display list, so we can 365 // drop our current one now 366 deleteDisplayListData(); 367 } 368 } 369} 370 371void RenderNode::decParentRefCount() { 372 LOG_ALWAYS_FATAL_IF(!mParentCount, "already 0!"); 373 mParentCount--; 374 if (!mParentCount) { 375 // If a child of ours is being attached to our parent then this will incorrectly 376 // destroy its hardware resources. However, this situation is highly unlikely 377 // and the failure is "just" that the layer is re-created, so this should 378 // be safe enough 379 destroyHardwareResources(); 380 } 381} 382 383/* 384 * For property operations, we pass a savecount of 0, since the operations aren't part of the 385 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in 386 * base saveCount (i.e., how RestoreToCount uses saveCount + properties().getCount()) 387 */ 388#define PROPERTY_SAVECOUNT 0 389 390template <class T> 391void RenderNode::setViewProperties(OpenGLRenderer& renderer, T& handler) { 392#if DEBUG_DISPLAY_LIST 393 properties().debugOutputProperties(handler.level() + 1); 394#endif 395 if (properties().getLeft() != 0 || properties().getTop() != 0) { 396 renderer.translate(properties().getLeft(), properties().getTop()); 397 } 398 if (properties().getStaticMatrix()) { 399 renderer.concatMatrix(*properties().getStaticMatrix()); 400 } else if (properties().getAnimationMatrix()) { 401 renderer.concatMatrix(*properties().getAnimationMatrix()); 402 } 403 if (properties().hasTransformMatrix()) { 404 if (properties().isTransformTranslateOnly()) { 405 renderer.translate(properties().getTranslationX(), properties().getTranslationY()); 406 } else { 407 renderer.concatMatrix(*properties().getTransformMatrix()); 408 } 409 } 410 const bool isLayer = properties().layerProperties().type() != kLayerTypeNone; 411 int clipFlags = properties().getClippingFlags(); 412 if (properties().getAlpha() < 1) { 413 if (isLayer) { 414 clipFlags &= ~CLIP_TO_BOUNDS; // bounds clipping done by layer 415 416 renderer.setOverrideLayerAlpha(properties().getAlpha()); 417 } else if (!properties().getHasOverlappingRendering()) { 418 renderer.scaleAlpha(properties().getAlpha()); 419 } else { 420 Rect layerBounds(0, 0, getWidth(), getHeight()); 421 int saveFlags = SkCanvas::kHasAlphaLayer_SaveFlag; 422 if (clipFlags) { 423 saveFlags |= SkCanvas::kClipToLayer_SaveFlag; 424 properties().getClippingRectForFlags(clipFlags, &layerBounds); 425 clipFlags = 0; // all clipping done by saveLayer 426 } 427 428 ATRACE_FORMAT("%s alpha caused %ssaveLayer %dx%d", 429 getName(), clipFlags ? "" : "unclipped ", 430 (int)layerBounds.getWidth(), (int)layerBounds.getHeight()); 431 432 SaveLayerOp* op = new (handler.allocator()) SaveLayerOp( 433 layerBounds.left, layerBounds.top, layerBounds.right, layerBounds.bottom, 434 properties().getAlpha() * 255, saveFlags); 435 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 436 } 437 } 438 if (clipFlags) { 439 Rect clipRect; 440 properties().getClippingRectForFlags(clipFlags, &clipRect); 441 ClipRectOp* op = new (handler.allocator()) ClipRectOp( 442 clipRect.left, clipRect.top, clipRect.right, clipRect.bottom, 443 SkRegion::kIntersect_Op); 444 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 445 } 446 447 // TODO: support nesting round rect clips 448 if (mProperties.getRevealClip().willClip()) { 449 Rect bounds; 450 mProperties.getRevealClip().getBounds(&bounds); 451 renderer.setClippingRoundRect(handler.allocator(), bounds, mProperties.getRevealClip().getRadius()); 452 } else if (mProperties.getOutline().willClip()) { 453 renderer.setClippingOutline(handler.allocator(), &(mProperties.getOutline())); 454 } 455} 456 457/** 458 * Apply property-based transformations to input matrix 459 * 460 * If true3dTransform is set to true, the transform applied to the input matrix will use true 4x4 461 * matrix computation instead of the Skia 3x3 matrix + camera hackery. 462 */ 463void RenderNode::applyViewPropertyTransforms(mat4& matrix, bool true3dTransform) const { 464 if (properties().getLeft() != 0 || properties().getTop() != 0) { 465 matrix.translate(properties().getLeft(), properties().getTop()); 466 } 467 if (properties().getStaticMatrix()) { 468 mat4 stat(*properties().getStaticMatrix()); 469 matrix.multiply(stat); 470 } else if (properties().getAnimationMatrix()) { 471 mat4 anim(*properties().getAnimationMatrix()); 472 matrix.multiply(anim); 473 } 474 475 bool applyTranslationZ = true3dTransform && !MathUtils::isZero(properties().getZ()); 476 if (properties().hasTransformMatrix() || applyTranslationZ) { 477 if (properties().isTransformTranslateOnly()) { 478 matrix.translate(properties().getTranslationX(), properties().getTranslationY(), 479 true3dTransform ? properties().getZ() : 0.0f); 480 } else { 481 if (!true3dTransform) { 482 matrix.multiply(*properties().getTransformMatrix()); 483 } else { 484 mat4 true3dMat; 485 true3dMat.loadTranslate( 486 properties().getPivotX() + properties().getTranslationX(), 487 properties().getPivotY() + properties().getTranslationY(), 488 properties().getZ()); 489 true3dMat.rotate(properties().getRotationX(), 1, 0, 0); 490 true3dMat.rotate(properties().getRotationY(), 0, 1, 0); 491 true3dMat.rotate(properties().getRotation(), 0, 0, 1); 492 true3dMat.scale(properties().getScaleX(), properties().getScaleY(), 1); 493 true3dMat.translate(-properties().getPivotX(), -properties().getPivotY()); 494 495 matrix.multiply(true3dMat); 496 } 497 } 498 } 499} 500 501/** 502 * Organizes the DisplayList hierarchy to prepare for background projection reordering. 503 * 504 * This should be called before a call to defer() or drawDisplayList() 505 * 506 * Each DisplayList that serves as a 3d root builds its list of composited children, 507 * which are flagged to not draw in the standard draw loop. 508 */ 509void RenderNode::computeOrdering() { 510 ATRACE_CALL(); 511 mProjectedNodes.clear(); 512 513 // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that 514 // transform properties are applied correctly to top level children 515 if (mDisplayListData == nullptr) return; 516 for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) { 517 DrawRenderNodeOp* childOp = mDisplayListData->children()[i]; 518 childOp->mRenderNode->computeOrderingImpl(childOp, 519 properties().getOutline().getPath(), &mProjectedNodes, &mat4::identity()); 520 } 521} 522 523void RenderNode::computeOrderingImpl( 524 DrawRenderNodeOp* opState, 525 const SkPath* outlineOfProjectionSurface, 526 Vector<DrawRenderNodeOp*>* compositedChildrenOfProjectionSurface, 527 const mat4* transformFromProjectionSurface) { 528 mProjectedNodes.clear(); 529 if (mDisplayListData == nullptr || mDisplayListData->isEmpty()) return; 530 531 // TODO: should avoid this calculation in most cases 532 // TODO: just calculate single matrix, down to all leaf composited elements 533 Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface); 534 localTransformFromProjectionSurface.multiply(opState->mTransformFromParent); 535 536 if (properties().getProjectBackwards()) { 537 // composited projectee, flag for out of order draw, save matrix, and store in proj surface 538 opState->mSkipInOrderDraw = true; 539 opState->mTransformFromCompositingAncestor.load(localTransformFromProjectionSurface); 540 compositedChildrenOfProjectionSurface->add(opState); 541 } else { 542 // standard in order draw 543 opState->mSkipInOrderDraw = false; 544 } 545 546 if (mDisplayListData->children().size() > 0) { 547 const bool isProjectionReceiver = mDisplayListData->projectionReceiveIndex >= 0; 548 bool haveAppliedPropertiesToProjection = false; 549 for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) { 550 DrawRenderNodeOp* childOp = mDisplayListData->children()[i]; 551 RenderNode* child = childOp->mRenderNode; 552 553 const SkPath* projectionOutline = nullptr; 554 Vector<DrawRenderNodeOp*>* projectionChildren = nullptr; 555 const mat4* projectionTransform = nullptr; 556 if (isProjectionReceiver && !child->properties().getProjectBackwards()) { 557 // if receiving projections, collect projecting descendent 558 559 // Note that if a direct descendent is projecting backwards, we pass it's 560 // grandparent projection collection, since it shouldn't project onto it's 561 // parent, where it will already be drawing. 562 projectionOutline = properties().getOutline().getPath(); 563 projectionChildren = &mProjectedNodes; 564 projectionTransform = &mat4::identity(); 565 } else { 566 if (!haveAppliedPropertiesToProjection) { 567 applyViewPropertyTransforms(localTransformFromProjectionSurface); 568 haveAppliedPropertiesToProjection = true; 569 } 570 projectionOutline = outlineOfProjectionSurface; 571 projectionChildren = compositedChildrenOfProjectionSurface; 572 projectionTransform = &localTransformFromProjectionSurface; 573 } 574 child->computeOrderingImpl(childOp, 575 projectionOutline, projectionChildren, projectionTransform); 576 } 577 } 578} 579 580class DeferOperationHandler { 581public: 582 DeferOperationHandler(DeferStateStruct& deferStruct, int level) 583 : mDeferStruct(deferStruct), mLevel(level) {} 584 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) { 585 operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds); 586 } 587 inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); } 588 inline void startMark(const char* name) {} // do nothing 589 inline void endMark() {} 590 inline int level() { return mLevel; } 591 inline int replayFlags() { return mDeferStruct.mReplayFlags; } 592 inline SkPath* allocPathForFrame() { return mDeferStruct.allocPathForFrame(); } 593 594private: 595 DeferStateStruct& mDeferStruct; 596 const int mLevel; 597}; 598 599void RenderNode::defer(DeferStateStruct& deferStruct, const int level) { 600 DeferOperationHandler handler(deferStruct, level); 601 issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler); 602} 603 604class ReplayOperationHandler { 605public: 606 ReplayOperationHandler(ReplayStateStruct& replayStruct, int level) 607 : mReplayStruct(replayStruct), mLevel(level) {} 608 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) { 609#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS 610 mReplayStruct.mRenderer.eventMark(operation->name()); 611#endif 612 operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds); 613 } 614 inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); } 615 inline void startMark(const char* name) { 616 mReplayStruct.mRenderer.startMark(name); 617 } 618 inline void endMark() { 619 mReplayStruct.mRenderer.endMark(); 620 } 621 inline int level() { return mLevel; } 622 inline int replayFlags() { return mReplayStruct.mReplayFlags; } 623 inline SkPath* allocPathForFrame() { return mReplayStruct.allocPathForFrame(); } 624 625private: 626 ReplayStateStruct& mReplayStruct; 627 const int mLevel; 628}; 629 630void RenderNode::replay(ReplayStateStruct& replayStruct, const int level) { 631 ReplayOperationHandler handler(replayStruct, level); 632 issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler); 633} 634 635void RenderNode::buildZSortedChildList(const DisplayListData::Chunk& chunk, 636 Vector<ZDrawRenderNodeOpPair>& zTranslatedNodes) { 637 if (chunk.beginChildIndex == chunk.endChildIndex) return; 638 639 for (unsigned int i = chunk.beginChildIndex; i < chunk.endChildIndex; i++) { 640 DrawRenderNodeOp* childOp = mDisplayListData->children()[i]; 641 RenderNode* child = childOp->mRenderNode; 642 float childZ = child->properties().getZ(); 643 644 if (!MathUtils::isZero(childZ) && chunk.reorderChildren) { 645 zTranslatedNodes.add(ZDrawRenderNodeOpPair(childZ, childOp)); 646 childOp->mSkipInOrderDraw = true; 647 } else if (!child->properties().getProjectBackwards()) { 648 // regular, in order drawing DisplayList 649 childOp->mSkipInOrderDraw = false; 650 } 651 } 652 653 // Z sort any 3d children (stable-ness makes z compare fall back to standard drawing order) 654 std::stable_sort(zTranslatedNodes.begin(), zTranslatedNodes.end()); 655} 656 657template <class T> 658void RenderNode::issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler) { 659 if (properties().getAlpha() <= 0.0f 660 || properties().getOutline().getAlpha() <= 0.0f 661 || !properties().getOutline().getPath()) { 662 // no shadow to draw 663 return; 664 } 665 666 mat4 shadowMatrixXY(transformFromParent); 667 applyViewPropertyTransforms(shadowMatrixXY); 668 669 // Z matrix needs actual 3d transformation, so mapped z values will be correct 670 mat4 shadowMatrixZ(transformFromParent); 671 applyViewPropertyTransforms(shadowMatrixZ, true); 672 673 const SkPath* casterOutlinePath = properties().getOutline().getPath(); 674 const SkPath* revealClipPath = properties().getRevealClip().getPath(); 675 if (revealClipPath && revealClipPath->isEmpty()) return; 676 677 float casterAlpha = properties().getAlpha() * properties().getOutline().getAlpha(); 678 679 680 // holds temporary SkPath to store the result of intersections 681 SkPath* frameAllocatedPath = nullptr; 682 const SkPath* outlinePath = casterOutlinePath; 683 684 // intersect the outline with the reveal clip, if present 685 if (revealClipPath) { 686 frameAllocatedPath = handler.allocPathForFrame(); 687 688 Op(*outlinePath, *revealClipPath, kIntersect_PathOp, frameAllocatedPath); 689 outlinePath = frameAllocatedPath; 690 } 691 692 // intersect the outline with the clipBounds, if present 693 if (properties().getClippingFlags() & CLIP_TO_CLIP_BOUNDS) { 694 if (!frameAllocatedPath) { 695 frameAllocatedPath = handler.allocPathForFrame(); 696 } 697 698 Rect clipBounds; 699 properties().getClippingRectForFlags(CLIP_TO_CLIP_BOUNDS, &clipBounds); 700 SkPath clipBoundsPath; 701 clipBoundsPath.addRect(clipBounds.left, clipBounds.top, 702 clipBounds.right, clipBounds.bottom); 703 704 Op(*outlinePath, clipBoundsPath, kIntersect_PathOp, frameAllocatedPath); 705 outlinePath = frameAllocatedPath; 706 } 707 708 DisplayListOp* shadowOp = new (handler.allocator()) DrawShadowOp( 709 shadowMatrixXY, shadowMatrixZ, casterAlpha, outlinePath); 710 handler(shadowOp, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 711} 712 713#define SHADOW_DELTA 0.1f 714 715template <class T> 716void RenderNode::issueOperationsOf3dChildren(ChildrenSelectMode mode, 717 const Matrix4& initialTransform, const Vector<ZDrawRenderNodeOpPair>& zTranslatedNodes, 718 OpenGLRenderer& renderer, T& handler) { 719 const int size = zTranslatedNodes.size(); 720 if (size == 0 721 || (mode == kNegativeZChildren && zTranslatedNodes[0].key > 0.0f) 722 || (mode == kPositiveZChildren && zTranslatedNodes[size - 1].key < 0.0f)) { 723 // no 3d children to draw 724 return; 725 } 726 727 // Apply the base transform of the parent of the 3d children. This isolates 728 // 3d children of the current chunk from transformations made in previous chunks. 729 int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag); 730 renderer.setMatrix(initialTransform); 731 732 /** 733 * Draw shadows and (potential) casters mostly in order, but allow the shadows of casters 734 * with very similar Z heights to draw together. 735 * 736 * This way, if Views A & B have the same Z height and are both casting shadows, the shadows are 737 * underneath both, and neither's shadow is drawn on top of the other. 738 */ 739 const size_t nonNegativeIndex = findNonNegativeIndex(zTranslatedNodes); 740 size_t drawIndex, shadowIndex, endIndex; 741 if (mode == kNegativeZChildren) { 742 drawIndex = 0; 743 endIndex = nonNegativeIndex; 744 shadowIndex = endIndex; // draw no shadows 745 } else { 746 drawIndex = nonNegativeIndex; 747 endIndex = size; 748 shadowIndex = drawIndex; // potentially draw shadow for each pos Z child 749 } 750 751 DISPLAY_LIST_LOGD("%*s%d %s 3d children:", (handler.level() + 1) * 2, "", 752 endIndex - drawIndex, mode == kNegativeZChildren ? "negative" : "positive"); 753 754 float lastCasterZ = 0.0f; 755 while (shadowIndex < endIndex || drawIndex < endIndex) { 756 if (shadowIndex < endIndex) { 757 DrawRenderNodeOp* casterOp = zTranslatedNodes[shadowIndex].value; 758 RenderNode* caster = casterOp->mRenderNode; 759 const float casterZ = zTranslatedNodes[shadowIndex].key; 760 // attempt to render the shadow if the caster about to be drawn is its caster, 761 // OR if its caster's Z value is similar to the previous potential caster 762 if (shadowIndex == drawIndex || casterZ - lastCasterZ < SHADOW_DELTA) { 763 caster->issueDrawShadowOperation(casterOp->mTransformFromParent, handler); 764 765 lastCasterZ = casterZ; // must do this even if current caster not casting a shadow 766 shadowIndex++; 767 continue; 768 } 769 } 770 771 // only the actual child DL draw needs to be in save/restore, 772 // since it modifies the renderer's matrix 773 int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag); 774 775 DrawRenderNodeOp* childOp = zTranslatedNodes[drawIndex].value; 776 777 renderer.concatMatrix(childOp->mTransformFromParent); 778 childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone 779 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds()); 780 childOp->mSkipInOrderDraw = true; 781 782 renderer.restoreToCount(restoreTo); 783 drawIndex++; 784 } 785 renderer.restoreToCount(rootRestoreTo); 786} 787 788template <class T> 789void RenderNode::issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler) { 790 DISPLAY_LIST_LOGD("%*s%d projected children:", (handler.level() + 1) * 2, "", mProjectedNodes.size()); 791 const SkPath* projectionReceiverOutline = properties().getOutline().getPath(); 792 int restoreTo = renderer.getSaveCount(); 793 794 LinearAllocator& alloc = handler.allocator(); 795 handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag), 796 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 797 798 // Transform renderer to match background we're projecting onto 799 // (by offsetting canvas by translationX/Y of background rendernode, since only those are set) 800 const DisplayListOp* op = 801 (mDisplayListData->displayListOps[mDisplayListData->projectionReceiveIndex]); 802 const DrawRenderNodeOp* backgroundOp = reinterpret_cast<const DrawRenderNodeOp*>(op); 803 const RenderProperties& backgroundProps = backgroundOp->mRenderNode->properties(); 804 renderer.translate(backgroundProps.getTranslationX(), backgroundProps.getTranslationY()); 805 806 // If the projection reciever has an outline, we mask each of the projected rendernodes to it 807 // Either with clipRect, or special saveLayer masking 808 if (projectionReceiverOutline != nullptr) { 809 const SkRect& outlineBounds = projectionReceiverOutline->getBounds(); 810 if (projectionReceiverOutline->isRect(nullptr)) { 811 // mask to the rect outline simply with clipRect 812 ClipRectOp* clipOp = new (alloc) ClipRectOp( 813 outlineBounds.left(), outlineBounds.top(), 814 outlineBounds.right(), outlineBounds.bottom(), SkRegion::kIntersect_Op); 815 handler(clipOp, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 816 } else { 817 // wrap the projected RenderNodes with a SaveLayer that will mask to the outline 818 SaveLayerOp* op = new (alloc) SaveLayerOp( 819 outlineBounds.left(), outlineBounds.top(), 820 outlineBounds.right(), outlineBounds.bottom(), 821 255, SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag | SkCanvas::kARGB_ClipLayer_SaveFlag); 822 op->setMask(projectionReceiverOutline); 823 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 824 825 /* TODO: add optimizations here to take advantage of placement/size of projected 826 * children (which may shrink saveLayer area significantly). This is dependent on 827 * passing actual drawing/dirtying bounds of projected content down to native. 828 */ 829 } 830 } 831 832 // draw projected nodes 833 for (size_t i = 0; i < mProjectedNodes.size(); i++) { 834 DrawRenderNodeOp* childOp = mProjectedNodes[i]; 835 836 // matrix save, concat, and restore can be done safely without allocating operations 837 int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag); 838 renderer.concatMatrix(childOp->mTransformFromCompositingAncestor); 839 childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone 840 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds()); 841 childOp->mSkipInOrderDraw = true; 842 renderer.restoreToCount(restoreTo); 843 } 844 845 if (projectionReceiverOutline != nullptr) { 846 handler(new (alloc) RestoreToCountOp(restoreTo), 847 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 848 } 849} 850 851/** 852 * This function serves both defer and replay modes, and will organize the displayList's component 853 * operations for a single frame: 854 * 855 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of 856 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom 857 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the 858 * defer vs replay logic, per operation 859 */ 860template <class T> 861void RenderNode::issueOperations(OpenGLRenderer& renderer, T& handler) { 862 const int level = handler.level(); 863 if (mDisplayListData->isEmpty()) { 864 DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", level * 2, "", this, getName()); 865 return; 866 } 867 868 const bool drawLayer = (mLayer && (&renderer != mLayer->renderer.get())); 869 // If we are updating the contents of mLayer, we don't want to apply any of 870 // the RenderNode's properties to this issueOperations pass. Those will all 871 // be applied when the layer is drawn, aka when this is true. 872 const bool useViewProperties = (!mLayer || drawLayer); 873 if (useViewProperties) { 874 const Outline& outline = properties().getOutline(); 875 if (properties().getAlpha() <= 0 || (outline.getShouldClip() && outline.isEmpty())) { 876 DISPLAY_LIST_LOGD("%*sRejected display list (%p, %s)", level * 2, "", this, getName()); 877 return; 878 } 879 } 880 881 handler.startMark(getName()); 882 883#if DEBUG_DISPLAY_LIST 884 const Rect& clipRect = renderer.getLocalClipBounds(); 885 DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), localClipBounds: %.0f, %.0f, %.0f, %.0f", 886 level * 2, "", this, getName(), 887 clipRect.left, clipRect.top, clipRect.right, clipRect.bottom); 888#endif 889 890 LinearAllocator& alloc = handler.allocator(); 891 int restoreTo = renderer.getSaveCount(); 892 handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag), 893 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 894 895 DISPLAY_LIST_LOGD("%*sSave %d %d", (level + 1) * 2, "", 896 SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag, restoreTo); 897 898 if (useViewProperties) { 899 setViewProperties<T>(renderer, handler); 900 } 901 902 bool quickRejected = properties().getClipToBounds() 903 && renderer.quickRejectConservative(0, 0, properties().getWidth(), properties().getHeight()); 904 if (!quickRejected) { 905 Matrix4 initialTransform(*(renderer.currentTransform())); 906 907 if (drawLayer) { 908 handler(new (alloc) DrawLayerOp(mLayer, 0, 0), 909 renderer.getSaveCount() - 1, properties().getClipToBounds()); 910 } else { 911 const int saveCountOffset = renderer.getSaveCount() - 1; 912 const int projectionReceiveIndex = mDisplayListData->projectionReceiveIndex; 913 DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance(); 914 for (size_t chunkIndex = 0; chunkIndex < mDisplayListData->getChunks().size(); chunkIndex++) { 915 const DisplayListData::Chunk& chunk = mDisplayListData->getChunks()[chunkIndex]; 916 917 Vector<ZDrawRenderNodeOpPair> zTranslatedNodes; 918 buildZSortedChildList(chunk, zTranslatedNodes); 919 920 issueOperationsOf3dChildren(kNegativeZChildren, 921 initialTransform, zTranslatedNodes, renderer, handler); 922 923 924 for (size_t opIndex = chunk.beginOpIndex; opIndex < chunk.endOpIndex; opIndex++) { 925 DisplayListOp *op = mDisplayListData->displayListOps[opIndex]; 926#if DEBUG_DISPLAY_LIST 927 op->output(level + 1); 928#endif 929 logBuffer.writeCommand(level, op->name()); 930 handler(op, saveCountOffset, properties().getClipToBounds()); 931 932 if (CC_UNLIKELY(!mProjectedNodes.isEmpty() && projectionReceiveIndex >= 0 && 933 opIndex == static_cast<size_t>(projectionReceiveIndex))) { 934 issueOperationsOfProjectedChildren(renderer, handler); 935 } 936 } 937 938 issueOperationsOf3dChildren(kPositiveZChildren, 939 initialTransform, zTranslatedNodes, renderer, handler); 940 } 941 } 942 } 943 944 DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (level + 1) * 2, "", restoreTo); 945 handler(new (alloc) RestoreToCountOp(restoreTo), 946 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 947 renderer.setOverrideLayerAlpha(1.0f); 948 949 DISPLAY_LIST_LOGD("%*sDone (%p, %s)", level * 2, "", this, getName()); 950 handler.endMark(); 951} 952 953} /* namespace uirenderer */ 954} /* namespace android */ 955