| // Copyright 2014 The Chromium Authors |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_GRAPHICS_COMPOSITING_REASONS_H_ |
| #define THIRD_PARTY_BLINK_RENDERER_PLATFORM_GRAPHICS_COMPOSITING_REASONS_H_ |
| |
| #include <stdint.h> |
| #include <vector> |
| #include "third_party/blink/renderer/platform/platform_export.h" |
| #include "third_party/blink/renderer/platform/wtf/allocator/allocator.h" |
| #include "third_party/blink/renderer/platform/wtf/text/wtf_string.h" |
| |
| namespace blink { |
| |
| using CompositingReasons = uint64_t; |
| |
| #define FOR_EACH_COMPOSITING_REASON(V) \ |
| /* Intrinsic reasons that can be known right away by the layer. */ \ |
| V(3DTransform) \ |
| V(3DScale) \ |
| V(3DRotate) \ |
| V(3DTranslate) \ |
| V(Trivial3DTransform) \ |
| V(IFrame) \ |
| V(ActiveTransformAnimation) \ |
| V(ActiveScaleAnimation) \ |
| V(ActiveRotateAnimation) \ |
| V(ActiveTranslateAnimation) \ |
| V(ActiveOpacityAnimation) \ |
| V(ActiveFilterAnimation) \ |
| V(ActiveBackdropFilterAnimation) \ |
| V(AffectedByOuterViewportBoundsDelta) \ |
| V(AffectedBySafeAreaBottom) \ |
| V(FixedPosition) \ |
| V(UndoOverscroll) \ |
| V(StickyPosition) \ |
| V(AnchorPosition) \ |
| V(BackdropFilter) \ |
| V(BackdropFilterMask) \ |
| V(RootScroller) \ |
| V(Viewport) \ |
| V(WillChangeTransform) \ |
| V(WillChangeScale) \ |
| V(WillChangeRotate) \ |
| V(WillChangeTranslate) \ |
| V(WillChangeOpacity) \ |
| V(WillChangeFilter) \ |
| V(WillChangeBackdropFilter) \ |
| V(WillChangeClipPath) \ |
| V(WillChangeMixBlendMode) \ |
| /* This flag is needed only when none of the explicit kWillChange* reasons \ |
| are set. */ \ |
| V(WillChangeOther) \ |
| \ |
| /* Reasons that depend on ancestor properties */ \ |
| V(BackfaceInvisibility3DAncestor) \ |
| /* TODO(crbug.com/1256990): Transform3DSceneLeaf today depends only on the \ |
| element and its properties, but in the future it could be optimized \ |
| to consider descendants and moved to the subtree group below. */ \ |
| V(Transform3DSceneLeaf) \ |
| \ |
| /* Subtree reasons that require knowing what the status of your subtree is \ |
| before knowing the answer. */ \ |
| V(PerspectiveWith3DDescendants) \ |
| V(Preserve3DWith3DDescendants) \ |
| \ |
| /* ViewTransition element. \ |
| See third_party/blink/renderer/core/view_transition/README.md. */ \ |
| V(ViewTransitionElement) \ |
| V(ViewTransitionPseudoElement) \ |
| V(ViewTransitionElementDescendantWithClipPath) \ |
| \ |
| /* For composited scrolling, determined after paint. */ \ |
| V(OverflowScrolling) \ |
| \ |
| /* Element is participating in element capture. */ \ |
| V(ElementCapture) \ |
| \ |
| /* The following reasons are not used in paint properties, but are \ |
| determined after paint, for debugging. See PaintArtifactCompositor. */ \ |
| /* This is based on overlapping relationship among pending layers. */ \ |
| V(Overlap) \ |
| /* These are based on the type of paint chunks and display items. */ \ |
| V(BackfaceVisibilityHidden) \ |
| V(FixedAttachmentBackground) \ |
| V(Caret) \ |
| V(Video) \ |
| V(Canvas) \ |
| V(Plugin) \ |
| V(Scrollbar) \ |
| V(LinkHighlight) \ |
| V(DevToolsOverlay) \ |
| V(ViewTransitionContent) |
| |
| class PLATFORM_EXPORT CompositingReason { |
| DISALLOW_NEW(); |
| |
| private: |
| // This contains ordinal values for compositing reasons and will be used to |
| // generate the compositing reason bits. |
| enum { |
| #define V(name) kE##name, |
| FOR_EACH_COMPOSITING_REASON(V) |
| #undef V |
| }; |
| |
| #define V(name) static_assert(kE##name < 64, "Should fit in 64 bits"); |
| FOR_EACH_COMPOSITING_REASON(V) |
| #undef V |
| |
| public: |
| static std::vector<const char*> ShortNames(CompositingReasons); |
| static std::vector<const char*> Descriptions(CompositingReasons); |
| static String ToString(CompositingReasons); |
| |
| enum : CompositingReasons { |
| kNone = 0, |
| kAll = ~static_cast<CompositingReasons>(0), |
| #define V(name) k##name = UINT64_C(1) << kE##name, |
| FOR_EACH_COMPOSITING_REASON(V) |
| #undef V |
| |
| // Various combinations of compositing reasons are defined here also, for |
| // more intuitive and faster bitwise logic. |
| |
| // Note that translate is not included, because we care about transforms |
| // that are not IsIdentityOrTranslation(). |
| kPreventingSubpixelAccumulationReasons = |
| kWillChangeTransform | kWillChangeScale | kWillChangeRotate, |
| kDirectReasonsForPaintOffsetTranslationProperty = |
| kFixedPosition | kAffectedByOuterViewportBoundsDelta | kUndoOverscroll | |
| kVideo | kCanvas | kPlugin | kIFrame | kAffectedBySafeAreaBottom, |
| // TODO(dbaron): kWillChangeOther probably shouldn't be in this list. |
| // TODO(vmpstr): kViewTransitionElement is needed to make sure that the |
| // capture escapes clips when view transition has a descendant that |
| // naturally escapes clips. See crbug.com/348590918 for details. |
| kDirectReasonsForTransformProperty = |
| k3DTransform | kTrivial3DTransform | kWillChangeTransform | |
| kWillChangeOther | kPerspectiveWith3DDescendants | |
| kPreserve3DWith3DDescendants | kActiveTransformAnimation | |
| kViewTransitionElementDescendantWithClipPath | kViewTransitionElement, |
| kDirectReasonsForScaleProperty = |
| k3DScale | kWillChangeScale | kActiveScaleAnimation, |
| kDirectReasonsForRotateProperty = |
| k3DRotate | kWillChangeRotate | kActiveRotateAnimation, |
| kDirectReasonsForTranslateProperty = |
| k3DTranslate | kWillChangeTranslate | kActiveTranslateAnimation, |
| kDirectReasonsForScrollTranslationProperty = |
| kRootScroller | kOverflowScrolling, |
| kDirectReasonsForEffectProperty = |
| kActiveOpacityAnimation | kWillChangeOpacity | kBackdropFilter | |
| kWillChangeBackdropFilter | kWillChangeClipPath | |
| kWillChangeMixBlendMode | kActiveBackdropFilterAnimation | |
| kViewTransitionPseudoElement | kTransform3DSceneLeaf | kElementCapture, |
| kDirectReasonsForFilterProperty = |
| kActiveFilterAnimation | kWillChangeFilter, |
| kDirectReasonsForBackdropFilter = kBackdropFilter | |
| kActiveBackdropFilterAnimation | |
| kWillChangeBackdropFilter, |
| |
| // These reasons also cause any effect or filter node that exists |
| // to be composited. They don't cause creation of a node. |
| // This is because 3D transforms and incorrect use of will-change:transform |
| // are likely indicators that compositing of effects is expected |
| // because certain changes to opacity, filter etc. will be made. |
| // Note that kWillChangeScale, kWillChangeRotate, and |
| // kWillChangeTranslate are not included since there is no |
| // web-compatibility reason to include them. |
| kAdditionalEffectCompositingTrigger = |
| k3DTransform | kTrivial3DTransform | kWillChangeTransform, |
| |
| // Cull rect expansion is required if the compositing reasons hint |
| // requirement of high-performance movement, to avoid frequent change of |
| // cull rect. |
| kRequiresCullRectExpansion = |
| kDirectReasonsForTransformProperty | kDirectReasonsForScaleProperty | |
| kDirectReasonsForRotateProperty | kDirectReasonsForTranslateProperty | |
| kDirectReasonsForScrollTranslationProperty | |
| // Normally a sticky element inherits the expanded contents cull rect of |
| // the scroll container, but it needs expansion by itself if there is |
| // additional clip between the sticky element and its scroll container. |
| // Similar for anchor positioned elements. |
| kStickyPosition | kAnchorPosition, |
| }; |
| }; |
| |
| } // namespace blink |
| |
| #endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_GRAPHICS_COMPOSITING_REASONS_H_ |
