RenderNode.cpp revision cd1c3eba69d044b551cededad75474038f919890
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#include "RenderNode.h" 18 19#include "DamageAccumulator.h" 20#include "Debug.h" 21#if HWUI_NEW_OPS 22#include "BakedOpRenderer.h" 23#include "RecordedOp.h" 24#include "OpDumper.h" 25#endif 26#include "DisplayListOp.h" 27#include "LayerRenderer.h" 28#include "OpenGLRenderer.h" 29#include "TreeInfo.h" 30#include "utils/MathUtils.h" 31#include "utils/TraceUtils.h" 32#include "renderthread/CanvasContext.h" 33 34#include "protos/hwui.pb.h" 35#include "protos/ProtoHelpers.h" 36 37#include <algorithm> 38#include <sstream> 39#include <string> 40 41namespace android { 42namespace uirenderer { 43 44void RenderNode::debugDumpLayers(const char* prefix) { 45#if HWUI_NEW_OPS 46 LOG_ALWAYS_FATAL("TODO: dump layer"); 47#else 48 if (mLayer) { 49 ALOGD("%sNode %p (%s) has layer %p (fbo = %u, wasBuildLayered = %s)", 50 prefix, this, getName(), mLayer, mLayer->getFbo(), 51 mLayer->wasBuildLayered ? "true" : "false"); 52 } 53#endif 54 if (mDisplayList) { 55 for (auto&& child : mDisplayList->getChildren()) { 56 child->renderNode->debugDumpLayers(prefix); 57 } 58 } 59} 60 61RenderNode::RenderNode() 62 : mDirtyPropertyFields(0) 63 , mNeedsDisplayListSync(false) 64 , mDisplayList(nullptr) 65 , mStagingDisplayList(nullptr) 66 , mAnimatorManager(*this) 67 , mParentCount(0) { 68} 69 70RenderNode::~RenderNode() { 71 deleteDisplayList(nullptr); 72 delete mStagingDisplayList; 73#if HWUI_NEW_OPS 74 LOG_ALWAYS_FATAL_IF(mLayer, "layer missed detachment!"); 75#else 76 if (mLayer) { 77 ALOGW("Memory Warning: Layer %p missed its detachment, held on to for far too long!", mLayer); 78 mLayer->postDecStrong(); 79 mLayer = nullptr; 80 } 81#endif 82} 83 84void RenderNode::setStagingDisplayList(DisplayList* displayList, TreeObserver* observer) { 85 mNeedsDisplayListSync = true; 86 delete mStagingDisplayList; 87 mStagingDisplayList = displayList; 88 // If mParentCount == 0 we are the sole reference to this RenderNode, 89 // so immediately free the old display list 90 if (!mParentCount && !mStagingDisplayList) { 91 deleteDisplayList(observer); 92 } 93} 94 95/** 96 * This function is a simplified version of replay(), where we simply retrieve and log the 97 * display list. This function should remain in sync with the replay() function. 98 */ 99#if HWUI_NEW_OPS 100void RenderNode::output(uint32_t level, const char* label) { 101 ALOGD("%s (%s %p%s%s%s%s%s)", 102 label, 103 getName(), 104 this, 105 (MathUtils::isZero(properties().getAlpha()) ? ", zero alpha" : ""), 106 (properties().hasShadow() ? ", casting shadow" : ""), 107 (isRenderable() ? "" : ", empty"), 108 (properties().getProjectBackwards() ? ", projected" : ""), 109 (mLayer != nullptr ? ", on HW Layer" : "")); 110 properties().debugOutputProperties(level + 1); 111 112 if (mDisplayList) { 113 for (auto&& op : mDisplayList->getOps()) { 114 std::stringstream strout; 115 OpDumper::dump(*op, strout, level + 1); 116 if (op->opId == RecordedOpId::RenderNodeOp) { 117 auto rnOp = reinterpret_cast<const RenderNodeOp*>(op); 118 rnOp->renderNode->output(level + 1, strout.str().c_str()); 119 } else { 120 ALOGD("%s", strout.str().c_str()); 121 } 122 } 123 } 124 ALOGD("%*s/RenderNode(%s %p)", level * 2, "", getName(), this); 125} 126#else 127void RenderNode::output(uint32_t level) { 128 ALOGD("%*sStart display list (%p, %s%s%s%s%s%s)", (level - 1) * 2, "", this, 129 getName(), 130 (MathUtils::isZero(properties().getAlpha()) ? ", zero alpha" : ""), 131 (properties().hasShadow() ? ", casting shadow" : ""), 132 (isRenderable() ? "" : ", empty"), 133 (properties().getProjectBackwards() ? ", projected" : ""), 134 (mLayer != nullptr ? ", on HW Layer" : "")); 135 ALOGD("%*s%s %d", level * 2, "", "Save", SaveFlags::MatrixClip); 136 properties().debugOutputProperties(level); 137 if (mDisplayList) { 138 // TODO: consider printing the chunk boundaries here 139 for (auto&& op : mDisplayList->getOps()) { 140 op->output(level, DisplayListOp::kOpLogFlag_Recurse); 141 } 142 } 143 ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, getName()); 144 } 145#endif 146 147void RenderNode::copyTo(proto::RenderNode *pnode) { 148 pnode->set_id(static_cast<uint64_t>( 149 reinterpret_cast<uintptr_t>(this))); 150 pnode->set_name(mName.string(), mName.length()); 151 152 proto::RenderProperties* pprops = pnode->mutable_properties(); 153 pprops->set_left(properties().getLeft()); 154 pprops->set_top(properties().getTop()); 155 pprops->set_right(properties().getRight()); 156 pprops->set_bottom(properties().getBottom()); 157 pprops->set_clip_flags(properties().getClippingFlags()); 158 pprops->set_alpha(properties().getAlpha()); 159 pprops->set_translation_x(properties().getTranslationX()); 160 pprops->set_translation_y(properties().getTranslationY()); 161 pprops->set_translation_z(properties().getTranslationZ()); 162 pprops->set_elevation(properties().getElevation()); 163 pprops->set_rotation(properties().getRotation()); 164 pprops->set_rotation_x(properties().getRotationX()); 165 pprops->set_rotation_y(properties().getRotationY()); 166 pprops->set_scale_x(properties().getScaleX()); 167 pprops->set_scale_y(properties().getScaleY()); 168 pprops->set_pivot_x(properties().getPivotX()); 169 pprops->set_pivot_y(properties().getPivotY()); 170 pprops->set_has_overlapping_rendering(properties().getHasOverlappingRendering()); 171 pprops->set_pivot_explicitly_set(properties().isPivotExplicitlySet()); 172 pprops->set_project_backwards(properties().getProjectBackwards()); 173 pprops->set_projection_receiver(properties().isProjectionReceiver()); 174 set(pprops->mutable_clip_bounds(), properties().getClipBounds()); 175 176 const Outline& outline = properties().getOutline(); 177 if (outline.getType() != Outline::Type::None) { 178 proto::Outline* poutline = pprops->mutable_outline(); 179 poutline->clear_path(); 180 if (outline.getType() == Outline::Type::Empty) { 181 poutline->set_type(proto::Outline_Type_Empty); 182 } else if (outline.getType() == Outline::Type::ConvexPath) { 183 poutline->set_type(proto::Outline_Type_ConvexPath); 184 if (const SkPath* path = outline.getPath()) { 185 set(poutline->mutable_path(), *path); 186 } 187 } else if (outline.getType() == Outline::Type::RoundRect) { 188 poutline->set_type(proto::Outline_Type_RoundRect); 189 } else { 190 ALOGW("Uknown outline type! %d", static_cast<int>(outline.getType())); 191 poutline->set_type(proto::Outline_Type_None); 192 } 193 poutline->set_should_clip(outline.getShouldClip()); 194 poutline->set_alpha(outline.getAlpha()); 195 poutline->set_radius(outline.getRadius()); 196 set(poutline->mutable_bounds(), outline.getBounds()); 197 } else { 198 pprops->clear_outline(); 199 } 200 201 const RevealClip& revealClip = properties().getRevealClip(); 202 if (revealClip.willClip()) { 203 proto::RevealClip* prevealClip = pprops->mutable_reveal_clip(); 204 prevealClip->set_x(revealClip.getX()); 205 prevealClip->set_y(revealClip.getY()); 206 prevealClip->set_radius(revealClip.getRadius()); 207 } else { 208 pprops->clear_reveal_clip(); 209 } 210 211 pnode->clear_children(); 212 if (mDisplayList) { 213 for (auto&& child : mDisplayList->getChildren()) { 214 child->renderNode->copyTo(pnode->add_children()); 215 } 216 } 217} 218 219int RenderNode::getDebugSize() { 220 int size = sizeof(RenderNode); 221 if (mStagingDisplayList) { 222 size += mStagingDisplayList->getUsedSize(); 223 } 224 if (mDisplayList && mDisplayList != mStagingDisplayList) { 225 size += mDisplayList->getUsedSize(); 226 } 227 return size; 228} 229 230void RenderNode::prepareTree(TreeInfo& info) { 231 ATRACE_CALL(); 232 LOG_ALWAYS_FATAL_IF(!info.damageAccumulator, "DamageAccumulator missing"); 233 234 // Functors don't correctly handle stencil usage of overdraw debugging - shove 'em in a layer. 235 bool functorsNeedLayer = Properties::debugOverdraw; 236 237 prepareTreeImpl(info, functorsNeedLayer); 238} 239 240void RenderNode::addAnimator(const sp<BaseRenderNodeAnimator>& animator) { 241 mAnimatorManager.addAnimator(animator); 242} 243 244void RenderNode::removeAnimator(const sp<BaseRenderNodeAnimator>& animator) { 245 mAnimatorManager.removeAnimator(animator); 246} 247 248void RenderNode::damageSelf(TreeInfo& info) { 249 if (isRenderable()) { 250 if (properties().getClipDamageToBounds()) { 251 info.damageAccumulator->dirty(0, 0, properties().getWidth(), properties().getHeight()); 252 } else { 253 // Hope this is big enough? 254 // TODO: Get this from the display list ops or something 255 info.damageAccumulator->dirty(DIRTY_MIN, DIRTY_MIN, DIRTY_MAX, DIRTY_MAX); 256 } 257 } 258} 259 260void RenderNode::prepareLayer(TreeInfo& info, uint32_t dirtyMask) { 261 LayerType layerType = properties().effectiveLayerType(); 262 if (CC_UNLIKELY(layerType == LayerType::RenderLayer)) { 263 // Damage applied so far needs to affect our parent, but does not require 264 // the layer to be updated. So we pop/push here to clear out the current 265 // damage and get a clean state for display list or children updates to 266 // affect, which will require the layer to be updated 267 info.damageAccumulator->popTransform(); 268 info.damageAccumulator->pushTransform(this); 269 if (dirtyMask & DISPLAY_LIST) { 270 damageSelf(info); 271 } 272 } 273} 274 275static layer_t* createLayer(RenderState& renderState, uint32_t width, uint32_t height) { 276#if HWUI_NEW_OPS 277 return renderState.layerPool().get(renderState, width, height); 278#else 279 return LayerRenderer::createRenderLayer(renderState, width, height); 280#endif 281} 282 283static void destroyLayer(layer_t* layer) { 284#if HWUI_NEW_OPS 285 RenderState& renderState = layer->renderState; 286 renderState.layerPool().putOrDelete(layer); 287#else 288 LayerRenderer::destroyLayer(layer); 289#endif 290} 291 292static bool layerMatchesWidthAndHeight(layer_t* layer, int width, int height) { 293#if HWUI_NEW_OPS 294 return layer->viewportWidth == (uint32_t) width && layer->viewportHeight == (uint32_t)height; 295#else 296 return layer->layer.getWidth() == width && layer->layer.getHeight() == height; 297#endif 298} 299 300void RenderNode::pushLayerUpdate(TreeInfo& info) { 301 LayerType layerType = properties().effectiveLayerType(); 302 // If we are not a layer OR we cannot be rendered (eg, view was detached) 303 // we need to destroy any Layers we may have had previously 304 if (CC_LIKELY(layerType != LayerType::RenderLayer) || CC_UNLIKELY(!isRenderable())) { 305 if (CC_UNLIKELY(mLayer)) { 306 destroyLayer(mLayer); 307 mLayer = nullptr; 308 } 309 return; 310 } 311 312 bool transformUpdateNeeded = false; 313 if (!mLayer) { 314 mLayer = createLayer(info.canvasContext.getRenderState(), getWidth(), getHeight()); 315#if !HWUI_NEW_OPS 316 applyLayerPropertiesToLayer(info); 317#endif 318 damageSelf(info); 319 transformUpdateNeeded = true; 320 } else if (!layerMatchesWidthAndHeight(mLayer, getWidth(), getHeight())) { 321#if HWUI_NEW_OPS 322 RenderState& renderState = mLayer->renderState; 323 if (properties().fitsOnLayer()) { 324 mLayer = renderState.layerPool().resize(mLayer, getWidth(), getHeight()); 325 } else { 326#else 327 if (!LayerRenderer::resizeLayer(mLayer, getWidth(), getHeight())) { 328#endif 329 destroyLayer(mLayer); 330 mLayer = nullptr; 331 } 332 damageSelf(info); 333 transformUpdateNeeded = true; 334 } 335 336 SkRect dirty; 337 info.damageAccumulator->peekAtDirty(&dirty); 338 339 if (!mLayer) { 340 Caches::getInstance().dumpMemoryUsage(); 341 if (info.errorHandler) { 342 std::ostringstream err; 343 err << "Unable to create layer for " << getName(); 344 const int maxTextureSize = Caches::getInstance().maxTextureSize; 345 if (getWidth() > maxTextureSize || getHeight() > maxTextureSize) { 346 err << ", size " << getWidth() << "x" << getHeight() 347 << " exceeds max size " << maxTextureSize; 348 } else { 349 err << ", see logcat for more info"; 350 } 351 info.errorHandler->onError(err.str()); 352 } 353 return; 354 } 355 356 if (transformUpdateNeeded && mLayer) { 357 // update the transform in window of the layer to reset its origin wrt light source position 358 Matrix4 windowTransform; 359 info.damageAccumulator->computeCurrentTransform(&windowTransform); 360 mLayer->setWindowTransform(windowTransform); 361 } 362 363#if HWUI_NEW_OPS 364 info.layerUpdateQueue->enqueueLayerWithDamage(this, dirty); 365#else 366 if (dirty.intersect(0, 0, getWidth(), getHeight())) { 367 dirty.roundOut(&dirty); 368 mLayer->updateDeferred(this, dirty.fLeft, dirty.fTop, dirty.fRight, dirty.fBottom); 369 } 370 // This is not inside the above if because we may have called 371 // updateDeferred on a previous prepare pass that didn't have a renderer 372 if (info.renderer && mLayer->deferredUpdateScheduled) { 373 info.renderer->pushLayerUpdate(mLayer); 374 } 375#endif 376 377 // There might be prefetched layers that need to be accounted for. 378 // That might be us, so tell CanvasContext that this layer is in the 379 // tree and should not be destroyed. 380 info.canvasContext.markLayerInUse(this); 381} 382 383/** 384 * Traverse down the the draw tree to prepare for a frame. 385 * 386 * MODE_FULL = UI Thread-driven (thus properties must be synced), otherwise RT driven 387 * 388 * While traversing down the tree, functorsNeedLayer flag is set to true if anything that uses the 389 * stencil buffer may be needed. Views that use a functor to draw will be forced onto a layer. 390 */ 391void RenderNode::prepareTreeImpl(TreeInfo& info, bool functorsNeedLayer) { 392 info.damageAccumulator->pushTransform(this); 393 394 if (info.mode == TreeInfo::MODE_FULL) { 395 pushStagingPropertiesChanges(info); 396 } 397 uint32_t animatorDirtyMask = 0; 398 if (CC_LIKELY(info.runAnimations)) { 399 animatorDirtyMask = mAnimatorManager.animate(info); 400 } 401 402 bool willHaveFunctor = false; 403 if (info.mode == TreeInfo::MODE_FULL && mStagingDisplayList) { 404 willHaveFunctor = !mStagingDisplayList->getFunctors().empty(); 405 } else if (mDisplayList) { 406 willHaveFunctor = !mDisplayList->getFunctors().empty(); 407 } 408 bool childFunctorsNeedLayer = mProperties.prepareForFunctorPresence( 409 willHaveFunctor, functorsNeedLayer); 410 411 if (CC_UNLIKELY(mPositionListener.get())) { 412 mPositionListener->onPositionUpdated(*this, info); 413 } 414 415 prepareLayer(info, animatorDirtyMask); 416 if (info.mode == TreeInfo::MODE_FULL) { 417 pushStagingDisplayListChanges(info); 418 } 419 prepareSubTree(info, childFunctorsNeedLayer, mDisplayList); 420 pushLayerUpdate(info); 421 422 info.damageAccumulator->popTransform(); 423} 424 425void RenderNode::syncProperties() { 426 mProperties = mStagingProperties; 427} 428 429void RenderNode::pushStagingPropertiesChanges(TreeInfo& info) { 430 // Push the animators first so that setupStartValueIfNecessary() is called 431 // before properties() is trampled by stagingProperties(), as they are 432 // required by some animators. 433 if (CC_LIKELY(info.runAnimations)) { 434 mAnimatorManager.pushStaging(); 435 } 436 if (mDirtyPropertyFields) { 437 mDirtyPropertyFields = 0; 438 damageSelf(info); 439 info.damageAccumulator->popTransform(); 440 syncProperties(); 441#if !HWUI_NEW_OPS 442 applyLayerPropertiesToLayer(info); 443#endif 444 // We could try to be clever and only re-damage if the matrix changed. 445 // However, we don't need to worry about that. The cost of over-damaging 446 // here is only going to be a single additional map rect of this node 447 // plus a rect join(). The parent's transform (and up) will only be 448 // performed once. 449 info.damageAccumulator->pushTransform(this); 450 damageSelf(info); 451 } 452} 453 454#if !HWUI_NEW_OPS 455void RenderNode::applyLayerPropertiesToLayer(TreeInfo& info) { 456 if (CC_LIKELY(!mLayer)) return; 457 458 const LayerProperties& props = properties().layerProperties(); 459 mLayer->setAlpha(props.alpha(), props.xferMode()); 460 mLayer->setColorFilter(props.colorFilter()); 461 mLayer->setBlend(props.needsBlending()); 462} 463#endif 464 465void RenderNode::syncDisplayList(TreeObserver* observer) { 466 // Make sure we inc first so that we don't fluctuate between 0 and 1, 467 // which would thrash the layer cache 468 if (mStagingDisplayList) { 469 for (auto&& child : mStagingDisplayList->getChildren()) { 470 child->renderNode->incParentRefCount(); 471 } 472 } 473 deleteDisplayList(observer); 474 mDisplayList = mStagingDisplayList; 475 mStagingDisplayList = nullptr; 476 if (mDisplayList) { 477 for (auto& iter : mDisplayList->getFunctors()) { 478 (*iter.functor)(DrawGlInfo::kModeSync, nullptr); 479 } 480 for (size_t i = 0; i < mDisplayList->getPushStagingFunctors().size(); i++) { 481 (*mDisplayList->getPushStagingFunctors()[i])(); 482 } 483 } 484} 485 486void RenderNode::pushStagingDisplayListChanges(TreeInfo& info) { 487 if (mNeedsDisplayListSync) { 488 mNeedsDisplayListSync = false; 489 // Damage with the old display list first then the new one to catch any 490 // changes in isRenderable or, in the future, bounds 491 damageSelf(info); 492 syncDisplayList(info.observer); 493 damageSelf(info); 494 } 495} 496 497void RenderNode::deleteDisplayList(TreeObserver* observer) { 498 if (mDisplayList) { 499 for (auto&& child : mDisplayList->getChildren()) { 500 child->renderNode->decParentRefCount(observer); 501 } 502 } 503 delete mDisplayList; 504 mDisplayList = nullptr; 505} 506 507void RenderNode::prepareSubTree(TreeInfo& info, bool functorsNeedLayer, DisplayList* subtree) { 508 if (subtree) { 509 TextureCache& cache = Caches::getInstance().textureCache; 510 info.out.hasFunctors |= subtree->getFunctors().size(); 511 for (auto&& bitmapResource : subtree->getBitmapResources()) { 512 void* ownerToken = &info.canvasContext; 513 info.prepareTextures = cache.prefetchAndMarkInUse(ownerToken, bitmapResource); 514 } 515 for (auto&& op : subtree->getChildren()) { 516 RenderNode* childNode = op->renderNode; 517#if HWUI_NEW_OPS 518 info.damageAccumulator->pushTransform(&op->localMatrix); 519 bool childFunctorsNeedLayer = functorsNeedLayer; // TODO! || op->mRecordedWithPotentialStencilClip; 520#else 521 info.damageAccumulator->pushTransform(&op->localMatrix); 522 bool childFunctorsNeedLayer = functorsNeedLayer 523 // Recorded with non-rect clip, or canvas-rotated by parent 524 || op->mRecordedWithPotentialStencilClip; 525#endif 526 childNode->prepareTreeImpl(info, childFunctorsNeedLayer); 527 info.damageAccumulator->popTransform(); 528 } 529 } 530} 531 532void RenderNode::destroyHardwareResources(TreeObserver* observer) { 533 if (mLayer) { 534 destroyLayer(mLayer); 535 mLayer = nullptr; 536 } 537 if (mDisplayList) { 538 for (auto&& child : mDisplayList->getChildren()) { 539 child->renderNode->destroyHardwareResources(observer); 540 } 541 if (mNeedsDisplayListSync) { 542 // Next prepare tree we are going to push a new display list, so we can 543 // drop our current one now 544 deleteDisplayList(observer); 545 } 546 } 547} 548 549void RenderNode::decParentRefCount(TreeObserver* observer) { 550 LOG_ALWAYS_FATAL_IF(!mParentCount, "already 0!"); 551 mParentCount--; 552 if (!mParentCount) { 553 if (observer) { 554 observer->onMaybeRemovedFromTree(this); 555 } 556 // If a child of ours is being attached to our parent then this will incorrectly 557 // destroy its hardware resources. However, this situation is highly unlikely 558 // and the failure is "just" that the layer is re-created, so this should 559 // be safe enough 560 destroyHardwareResources(observer); 561 } 562} 563 564/* 565 * For property operations, we pass a savecount of 0, since the operations aren't part of the 566 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in 567 * base saveCount (i.e., how RestoreToCount uses saveCount + properties().getCount()) 568 */ 569#define PROPERTY_SAVECOUNT 0 570 571template <class T> 572void RenderNode::setViewProperties(OpenGLRenderer& renderer, T& handler) { 573#if DEBUG_DISPLAY_LIST 574 properties().debugOutputProperties(handler.level() + 1); 575#endif 576 if (properties().getLeft() != 0 || properties().getTop() != 0) { 577 renderer.translate(properties().getLeft(), properties().getTop()); 578 } 579 if (properties().getStaticMatrix()) { 580 renderer.concatMatrix(*properties().getStaticMatrix()); 581 } else if (properties().getAnimationMatrix()) { 582 renderer.concatMatrix(*properties().getAnimationMatrix()); 583 } 584 if (properties().hasTransformMatrix()) { 585 if (properties().isTransformTranslateOnly()) { 586 renderer.translate(properties().getTranslationX(), properties().getTranslationY()); 587 } else { 588 renderer.concatMatrix(*properties().getTransformMatrix()); 589 } 590 } 591 const bool isLayer = properties().effectiveLayerType() != LayerType::None; 592 int clipFlags = properties().getClippingFlags(); 593 if (properties().getAlpha() < 1) { 594 if (isLayer) { 595 clipFlags &= ~CLIP_TO_BOUNDS; // bounds clipping done by layer 596 } 597 if (CC_LIKELY(isLayer || !properties().getHasOverlappingRendering())) { 598 // simply scale rendering content's alpha 599 renderer.scaleAlpha(properties().getAlpha()); 600 } else { 601 // savelayer needed to create an offscreen buffer 602 Rect layerBounds(0, 0, getWidth(), getHeight()); 603 if (clipFlags) { 604 properties().getClippingRectForFlags(clipFlags, &layerBounds); 605 clipFlags = 0; // all clipping done by savelayer 606 } 607 SaveLayerOp* op = new (handler.allocator()) SaveLayerOp( 608 layerBounds.left, layerBounds.top, 609 layerBounds.right, layerBounds.bottom, 610 (int) (properties().getAlpha() * 255), 611 SaveFlags::HasAlphaLayer | SaveFlags::ClipToLayer); 612 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 613 } 614 615 if (CC_UNLIKELY(ATRACE_ENABLED() && properties().promotedToLayer())) { 616 // pretend alpha always causes savelayer to warn about 617 // performance problem affecting old versions 618 ATRACE_FORMAT("%s alpha caused saveLayer %dx%d", getName(), 619 static_cast<int>(getWidth()), 620 static_cast<int>(getHeight())); 621 } 622 } 623 if (clipFlags) { 624 Rect clipRect; 625 properties().getClippingRectForFlags(clipFlags, &clipRect); 626 ClipRectOp* op = new (handler.allocator()) ClipRectOp( 627 clipRect.left, clipRect.top, clipRect.right, clipRect.bottom, 628 SkRegion::kIntersect_Op); 629 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 630 } 631 632 // TODO: support nesting round rect clips 633 if (mProperties.getRevealClip().willClip()) { 634 Rect bounds; 635 mProperties.getRevealClip().getBounds(&bounds); 636 renderer.setClippingRoundRect(handler.allocator(), bounds, mProperties.getRevealClip().getRadius()); 637 } else if (mProperties.getOutline().willClip()) { 638 renderer.setClippingOutline(handler.allocator(), &(mProperties.getOutline())); 639 } 640} 641 642/** 643 * Apply property-based transformations to input matrix 644 * 645 * If true3dTransform is set to true, the transform applied to the input matrix will use true 4x4 646 * matrix computation instead of the Skia 3x3 matrix + camera hackery. 647 */ 648void RenderNode::applyViewPropertyTransforms(mat4& matrix, bool true3dTransform) const { 649 if (properties().getLeft() != 0 || properties().getTop() != 0) { 650 matrix.translate(properties().getLeft(), properties().getTop()); 651 } 652 if (properties().getStaticMatrix()) { 653 mat4 stat(*properties().getStaticMatrix()); 654 matrix.multiply(stat); 655 } else if (properties().getAnimationMatrix()) { 656 mat4 anim(*properties().getAnimationMatrix()); 657 matrix.multiply(anim); 658 } 659 660 bool applyTranslationZ = true3dTransform && !MathUtils::isZero(properties().getZ()); 661 if (properties().hasTransformMatrix() || applyTranslationZ) { 662 if (properties().isTransformTranslateOnly()) { 663 matrix.translate(properties().getTranslationX(), properties().getTranslationY(), 664 true3dTransform ? properties().getZ() : 0.0f); 665 } else { 666 if (!true3dTransform) { 667 matrix.multiply(*properties().getTransformMatrix()); 668 } else { 669 mat4 true3dMat; 670 true3dMat.loadTranslate( 671 properties().getPivotX() + properties().getTranslationX(), 672 properties().getPivotY() + properties().getTranslationY(), 673 properties().getZ()); 674 true3dMat.rotate(properties().getRotationX(), 1, 0, 0); 675 true3dMat.rotate(properties().getRotationY(), 0, 1, 0); 676 true3dMat.rotate(properties().getRotation(), 0, 0, 1); 677 true3dMat.scale(properties().getScaleX(), properties().getScaleY(), 1); 678 true3dMat.translate(-properties().getPivotX(), -properties().getPivotY()); 679 680 matrix.multiply(true3dMat); 681 } 682 } 683 } 684} 685 686/** 687 * Organizes the DisplayList hierarchy to prepare for background projection reordering. 688 * 689 * This should be called before a call to defer() or drawDisplayList() 690 * 691 * Each DisplayList that serves as a 3d root builds its list of composited children, 692 * which are flagged to not draw in the standard draw loop. 693 */ 694void RenderNode::computeOrdering() { 695 ATRACE_CALL(); 696 mProjectedNodes.clear(); 697 698 // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that 699 // transform properties are applied correctly to top level children 700 if (mDisplayList == nullptr) return; 701 for (unsigned int i = 0; i < mDisplayList->getChildren().size(); i++) { 702 renderNodeOp_t* childOp = mDisplayList->getChildren()[i]; 703 childOp->renderNode->computeOrderingImpl(childOp, &mProjectedNodes, &mat4::identity()); 704 } 705} 706 707void RenderNode::computeOrderingImpl( 708 renderNodeOp_t* opState, 709 std::vector<renderNodeOp_t*>* compositedChildrenOfProjectionSurface, 710 const mat4* transformFromProjectionSurface) { 711 mProjectedNodes.clear(); 712 if (mDisplayList == nullptr || mDisplayList->isEmpty()) return; 713 714 // TODO: should avoid this calculation in most cases 715 // TODO: just calculate single matrix, down to all leaf composited elements 716 Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface); 717 localTransformFromProjectionSurface.multiply(opState->localMatrix); 718 719 if (properties().getProjectBackwards()) { 720 // composited projectee, flag for out of order draw, save matrix, and store in proj surface 721 opState->skipInOrderDraw = true; 722 opState->transformFromCompositingAncestor = localTransformFromProjectionSurface; 723 compositedChildrenOfProjectionSurface->push_back(opState); 724 } else { 725 // standard in order draw 726 opState->skipInOrderDraw = false; 727 } 728 729 if (mDisplayList->getChildren().size() > 0) { 730 const bool isProjectionReceiver = mDisplayList->projectionReceiveIndex >= 0; 731 bool haveAppliedPropertiesToProjection = false; 732 for (unsigned int i = 0; i < mDisplayList->getChildren().size(); i++) { 733 renderNodeOp_t* childOp = mDisplayList->getChildren()[i]; 734 RenderNode* child = childOp->renderNode; 735 736 std::vector<renderNodeOp_t*>* projectionChildren = nullptr; 737 const mat4* projectionTransform = nullptr; 738 if (isProjectionReceiver && !child->properties().getProjectBackwards()) { 739 // if receiving projections, collect projecting descendant 740 741 // Note that if a direct descendant is projecting backwards, we pass its 742 // grandparent projection collection, since it shouldn't project onto its 743 // parent, where it will already be drawing. 744 projectionChildren = &mProjectedNodes; 745 projectionTransform = &mat4::identity(); 746 } else { 747 if (!haveAppliedPropertiesToProjection) { 748 applyViewPropertyTransforms(localTransformFromProjectionSurface); 749 haveAppliedPropertiesToProjection = true; 750 } 751 projectionChildren = compositedChildrenOfProjectionSurface; 752 projectionTransform = &localTransformFromProjectionSurface; 753 } 754 child->computeOrderingImpl(childOp, projectionChildren, projectionTransform); 755 } 756 } 757} 758 759class DeferOperationHandler { 760public: 761 DeferOperationHandler(DeferStateStruct& deferStruct, int level) 762 : mDeferStruct(deferStruct), mLevel(level) {} 763 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) { 764 operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds); 765 } 766 inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); } 767 inline void startMark(const char* name) {} // do nothing 768 inline void endMark() {} 769 inline int level() { return mLevel; } 770 inline int replayFlags() { return mDeferStruct.mReplayFlags; } 771 inline SkPath* allocPathForFrame() { return mDeferStruct.allocPathForFrame(); } 772 773private: 774 DeferStateStruct& mDeferStruct; 775 const int mLevel; 776}; 777 778void RenderNode::defer(DeferStateStruct& deferStruct, const int level) { 779 DeferOperationHandler handler(deferStruct, level); 780 issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler); 781} 782 783class ReplayOperationHandler { 784public: 785 ReplayOperationHandler(ReplayStateStruct& replayStruct, int level) 786 : mReplayStruct(replayStruct), mLevel(level) {} 787 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) { 788#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS 789 mReplayStruct.mRenderer.eventMark(operation->name()); 790#endif 791 operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds); 792 } 793 inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); } 794 inline void startMark(const char* name) { 795 mReplayStruct.mRenderer.startMark(name); 796 } 797 inline void endMark() { 798 mReplayStruct.mRenderer.endMark(); 799 } 800 inline int level() { return mLevel; } 801 inline int replayFlags() { return mReplayStruct.mReplayFlags; } 802 inline SkPath* allocPathForFrame() { return mReplayStruct.allocPathForFrame(); } 803 804private: 805 ReplayStateStruct& mReplayStruct; 806 const int mLevel; 807}; 808 809void RenderNode::replay(ReplayStateStruct& replayStruct, const int level) { 810 ReplayOperationHandler handler(replayStruct, level); 811 issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler); 812} 813 814void RenderNode::buildZSortedChildList(const DisplayList::Chunk& chunk, 815 std::vector<ZDrawRenderNodeOpPair>& zTranslatedNodes) { 816#if !HWUI_NEW_OPS 817 if (chunk.beginChildIndex == chunk.endChildIndex) return; 818 819 for (unsigned int i = chunk.beginChildIndex; i < chunk.endChildIndex; i++) { 820 DrawRenderNodeOp* childOp = mDisplayList->getChildren()[i]; 821 RenderNode* child = childOp->renderNode; 822 float childZ = child->properties().getZ(); 823 824 if (!MathUtils::isZero(childZ) && chunk.reorderChildren) { 825 zTranslatedNodes.push_back(ZDrawRenderNodeOpPair(childZ, childOp)); 826 childOp->skipInOrderDraw = true; 827 } else if (!child->properties().getProjectBackwards()) { 828 // regular, in order drawing DisplayList 829 childOp->skipInOrderDraw = false; 830 } 831 } 832 833 // Z sort any 3d children (stable-ness makes z compare fall back to standard drawing order) 834 std::stable_sort(zTranslatedNodes.begin(), zTranslatedNodes.end()); 835#endif 836} 837 838template <class T> 839void RenderNode::issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler) { 840 if (properties().getAlpha() <= 0.0f 841 || properties().getOutline().getAlpha() <= 0.0f 842 || !properties().getOutline().getPath() 843 || properties().getScaleX() == 0 844 || properties().getScaleY() == 0) { 845 // no shadow to draw 846 return; 847 } 848 849 mat4 shadowMatrixXY(transformFromParent); 850 applyViewPropertyTransforms(shadowMatrixXY); 851 852 // Z matrix needs actual 3d transformation, so mapped z values will be correct 853 mat4 shadowMatrixZ(transformFromParent); 854 applyViewPropertyTransforms(shadowMatrixZ, true); 855 856 const SkPath* casterOutlinePath = properties().getOutline().getPath(); 857 const SkPath* revealClipPath = properties().getRevealClip().getPath(); 858 if (revealClipPath && revealClipPath->isEmpty()) return; 859 860 float casterAlpha = properties().getAlpha() * properties().getOutline().getAlpha(); 861 862 863 // holds temporary SkPath to store the result of intersections 864 SkPath* frameAllocatedPath = nullptr; 865 const SkPath* outlinePath = casterOutlinePath; 866 867 // intersect the outline with the reveal clip, if present 868 if (revealClipPath) { 869 frameAllocatedPath = handler.allocPathForFrame(); 870 871 Op(*outlinePath, *revealClipPath, kIntersect_SkPathOp, frameAllocatedPath); 872 outlinePath = frameAllocatedPath; 873 } 874 875 // intersect the outline with the clipBounds, if present 876 if (properties().getClippingFlags() & CLIP_TO_CLIP_BOUNDS) { 877 if (!frameAllocatedPath) { 878 frameAllocatedPath = handler.allocPathForFrame(); 879 } 880 881 Rect clipBounds; 882 properties().getClippingRectForFlags(CLIP_TO_CLIP_BOUNDS, &clipBounds); 883 SkPath clipBoundsPath; 884 clipBoundsPath.addRect(clipBounds.left, clipBounds.top, 885 clipBounds.right, clipBounds.bottom); 886 887 Op(*outlinePath, clipBoundsPath, kIntersect_SkPathOp, frameAllocatedPath); 888 outlinePath = frameAllocatedPath; 889 } 890 891 DisplayListOp* shadowOp = new (handler.allocator()) DrawShadowOp( 892 shadowMatrixXY, shadowMatrixZ, casterAlpha, outlinePath); 893 handler(shadowOp, PROPERTY_SAVECOUNT, properties().getClipToBounds()); 894} 895 896#define SHADOW_DELTA 0.1f 897 898template <class T> 899void RenderNode::issueOperationsOf3dChildren(ChildrenSelectMode mode, 900 const Matrix4& initialTransform, const std::vector<ZDrawRenderNodeOpPair>& zTranslatedNodes, 901 OpenGLRenderer& renderer, T& handler) { 902 const int size = zTranslatedNodes.size(); 903 if (size == 0 904 || (mode == ChildrenSelectMode::NegativeZChildren && zTranslatedNodes[0].key > 0.0f) 905 || (mode == ChildrenSelectMode::PositiveZChildren && zTranslatedNodes[size - 1].key < 0.0f)) { 906 // no 3d children to draw 907 return; 908 } 909 910 // Apply the base transform of the parent of the 3d children. This isolates 911 // 3d children of the current chunk from transformations made in previous chunks. 912 int rootRestoreTo = renderer.save(SaveFlags::Matrix); 913 renderer.setGlobalMatrix(initialTransform); 914 915 /** 916 * Draw shadows and (potential) casters mostly in order, but allow the shadows of casters 917 * with very similar Z heights to draw together. 918 * 919 * This way, if Views A & B have the same Z height and are both casting shadows, the shadows are 920 * underneath both, and neither's shadow is drawn on top of the other. 921 */ 922 const size_t nonNegativeIndex = findNonNegativeIndex(zTranslatedNodes); 923 size_t drawIndex, shadowIndex, endIndex; 924 if (mode == ChildrenSelectMode::NegativeZChildren) { 925 drawIndex = 0; 926 endIndex = nonNegativeIndex; 927 shadowIndex = endIndex; // draw no shadows 928 } else { 929 drawIndex = nonNegativeIndex; 930 endIndex = size; 931 shadowIndex = drawIndex; // potentially draw shadow for each pos Z child 932 } 933 934 DISPLAY_LIST_LOGD("%*s%d %s 3d children:", (handler.level() + 1) * 2, "", 935 endIndex - drawIndex, mode == kNegativeZChildren ? "negative" : "positive"); 936 937 float lastCasterZ = 0.0f; 938 while (shadowIndex < endIndex || drawIndex < endIndex) { 939 if (shadowIndex < endIndex) { 940 DrawRenderNodeOp* casterOp = zTranslatedNodes[shadowIndex].value; 941 RenderNode* caster = casterOp->renderNode; 942 const float casterZ = zTranslatedNodes[shadowIndex].key; 943 // attempt to render the shadow if the caster about to be drawn is its caster, 944 // OR if its caster's Z value is similar to the previous potential caster 945 if (shadowIndex == drawIndex || casterZ - lastCasterZ < SHADOW_DELTA) { 946 caster->issueDrawShadowOperation(casterOp->localMatrix, handler); 947 948 lastCasterZ = casterZ; // must do this even if current caster not casting a shadow 949 shadowIndex++; 950 continue; 951 } 952 } 953 954 // only the actual child DL draw needs to be in save/restore, 955 // since it modifies the renderer's matrix 956 int restoreTo = renderer.save(SaveFlags::Matrix); 957 958 DrawRenderNodeOp* childOp = zTranslatedNodes[drawIndex].value; 959 960 renderer.concatMatrix(childOp->localMatrix); 961 childOp->skipInOrderDraw = false; // this is horrible, I'm so sorry everyone 962 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds()); 963 childOp->skipInOrderDraw = true; 964 965 renderer.restoreToCount(restoreTo); 966 drawIndex++; 967 } 968 renderer.restoreToCount(rootRestoreTo); 969} 970 971template <class T> 972void RenderNode::issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler) { 973 DISPLAY_LIST_LOGD("%*s%d projected children:", (handler.level() + 1) * 2, "", mProjectedNodes.size()); 974 const SkPath* projectionReceiverOutline = properties().getOutline().getPath(); 975 int restoreTo = renderer.getSaveCount(); 976 977 LinearAllocator& alloc = handler.allocator(); 978 handler(new (alloc) SaveOp(SaveFlags::MatrixClip), 979 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 980 981 // Transform renderer to match background we're projecting onto 982 // (by offsetting canvas by translationX/Y of background rendernode, since only those are set) 983 const DisplayListOp* op = 984#if HWUI_NEW_OPS 985 nullptr; 986 LOG_ALWAYS_FATAL("unsupported"); 987#else 988 (mDisplayList->getOps()[mDisplayList->projectionReceiveIndex]); 989#endif 990 const DrawRenderNodeOp* backgroundOp = reinterpret_cast<const DrawRenderNodeOp*>(op); 991 const RenderProperties& backgroundProps = backgroundOp->renderNode->properties(); 992 renderer.translate(backgroundProps.getTranslationX(), backgroundProps.getTranslationY()); 993 994 // If the projection receiver has an outline, we mask projected content to it 995 // (which we know, apriori, are all tessellated paths) 996 renderer.setProjectionPathMask(alloc, projectionReceiverOutline); 997 998 // draw projected nodes 999 for (size_t i = 0; i < mProjectedNodes.size(); i++) { 1000 renderNodeOp_t* childOp = mProjectedNodes[i]; 1001 1002 // matrix save, concat, and restore can be done safely without allocating operations 1003 int restoreTo = renderer.save(SaveFlags::Matrix); 1004 renderer.concatMatrix(childOp->transformFromCompositingAncestor); 1005 childOp->skipInOrderDraw = false; // this is horrible, I'm so sorry everyone 1006 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds()); 1007 childOp->skipInOrderDraw = true; 1008 renderer.restoreToCount(restoreTo); 1009 } 1010 1011 handler(new (alloc) RestoreToCountOp(restoreTo), 1012 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 1013} 1014 1015/** 1016 * This function serves both defer and replay modes, and will organize the displayList's component 1017 * operations for a single frame: 1018 * 1019 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of 1020 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom 1021 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the 1022 * defer vs replay logic, per operation 1023 */ 1024template <class T> 1025void RenderNode::issueOperations(OpenGLRenderer& renderer, T& handler) { 1026 if (mDisplayList->isEmpty()) { 1027 DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", handler.level() * 2, "", 1028 this, getName()); 1029 return; 1030 } 1031 1032#if HWUI_NEW_OPS 1033 const bool drawLayer = false; 1034#else 1035 const bool drawLayer = (mLayer && (&renderer != mLayer->renderer.get())); 1036#endif 1037 // If we are updating the contents of mLayer, we don't want to apply any of 1038 // the RenderNode's properties to this issueOperations pass. Those will all 1039 // be applied when the layer is drawn, aka when this is true. 1040 const bool useViewProperties = (!mLayer || drawLayer); 1041 if (useViewProperties) { 1042 const Outline& outline = properties().getOutline(); 1043 if (properties().getAlpha() <= 0 1044 || (outline.getShouldClip() && outline.isEmpty()) 1045 || properties().getScaleX() == 0 1046 || properties().getScaleY() == 0) { 1047 DISPLAY_LIST_LOGD("%*sRejected display list (%p, %s)", handler.level() * 2, "", 1048 this, getName()); 1049 return; 1050 } 1051 } 1052 1053 handler.startMark(getName()); 1054 1055#if DEBUG_DISPLAY_LIST 1056 const Rect& clipRect = renderer.getLocalClipBounds(); 1057 DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), localClipBounds: %.0f, %.0f, %.0f, %.0f", 1058 handler.level() * 2, "", this, getName(), 1059 clipRect.left, clipRect.top, clipRect.right, clipRect.bottom); 1060#endif 1061 1062 LinearAllocator& alloc = handler.allocator(); 1063 int restoreTo = renderer.getSaveCount(); 1064 handler(new (alloc) SaveOp(SaveFlags::MatrixClip), 1065 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 1066 1067 DISPLAY_LIST_LOGD("%*sSave %d %d", (handler.level() + 1) * 2, "", 1068 SaveFlags::MatrixClip, restoreTo); 1069 1070 if (useViewProperties) { 1071 setViewProperties<T>(renderer, handler); 1072 } 1073 1074#if HWUI_NEW_OPS 1075 LOG_ALWAYS_FATAL("legacy op traversal not supported"); 1076#else 1077 bool quickRejected = properties().getClipToBounds() 1078 && renderer.quickRejectConservative(0, 0, properties().getWidth(), properties().getHeight()); 1079 if (!quickRejected) { 1080 Matrix4 initialTransform(*(renderer.currentTransform())); 1081 renderer.setBaseTransform(initialTransform); 1082 1083 if (drawLayer) { 1084 handler(new (alloc) DrawLayerOp(mLayer), 1085 renderer.getSaveCount() - 1, properties().getClipToBounds()); 1086 } else { 1087 const int saveCountOffset = renderer.getSaveCount() - 1; 1088 const int projectionReceiveIndex = mDisplayList->projectionReceiveIndex; 1089 for (size_t chunkIndex = 0; chunkIndex < mDisplayList->getChunks().size(); chunkIndex++) { 1090 const DisplayList::Chunk& chunk = mDisplayList->getChunks()[chunkIndex]; 1091 1092 std::vector<ZDrawRenderNodeOpPair> zTranslatedNodes; 1093 buildZSortedChildList(chunk, zTranslatedNodes); 1094 1095 issueOperationsOf3dChildren(ChildrenSelectMode::NegativeZChildren, 1096 initialTransform, zTranslatedNodes, renderer, handler); 1097 1098 for (size_t opIndex = chunk.beginOpIndex; opIndex < chunk.endOpIndex; opIndex++) { 1099 DisplayListOp *op = mDisplayList->getOps()[opIndex]; 1100#if DEBUG_DISPLAY_LIST 1101 op->output(handler.level() + 1); 1102#endif 1103 handler(op, saveCountOffset, properties().getClipToBounds()); 1104 1105 if (CC_UNLIKELY(!mProjectedNodes.empty() && projectionReceiveIndex >= 0 && 1106 opIndex == static_cast<size_t>(projectionReceiveIndex))) { 1107 issueOperationsOfProjectedChildren(renderer, handler); 1108 } 1109 } 1110 1111 issueOperationsOf3dChildren(ChildrenSelectMode::PositiveZChildren, 1112 initialTransform, zTranslatedNodes, renderer, handler); 1113 } 1114 } 1115 } 1116#endif 1117 1118 DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (handler.level() + 1) * 2, "", restoreTo); 1119 handler(new (alloc) RestoreToCountOp(restoreTo), 1120 PROPERTY_SAVECOUNT, properties().getClipToBounds()); 1121 1122 DISPLAY_LIST_LOGD("%*sDone (%p, %s)", handler.level() * 2, "", this, getName()); 1123 handler.endMark(); 1124} 1125 1126} /* namespace uirenderer */ 1127} /* namespace android */ 1128