blob: 4199cb904f907d0516f24658039d8725fbcd9c70 [file] [log] [blame]
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/heap/member.h"
namespace blink {
class DisplayLockContext;
class CORE_EXPORT DisplayLockBudget {
enum class Phase : unsigned {
kFirst = kStyle,
kLast = kPrePaint
virtual ~DisplayLockBudget() = default;
// Returns true if the given phase is allowed to proceed under the current
// budget.
virtual bool ShouldPerformPhase(Phase) const = 0;
// Notifies the budget that the given phase was completed.
virtual void DidPerformPhase(Phase) = 0;
// Notifies the budget that a new lifecycle update phase is going to start.
virtual void WillStartLifecycleUpdate() = 0;
// Returns true if according to this budget, we still need a lifecycle update.
// For example, if a budget blocked a needed phase, then it this will return
// true indicating that another frame is needed.
virtual bool NeedsLifecycleUpdates() const = 0;
// Marks the ancestor chain dirty for the given phase if it's needed. Returns
// true if the ancestors were marked dirty and false otherwise.
bool MarkAncestorsDirtyForPhaseIfNeeded(Phase);
// Returns true if there is likely to be work for the given phase.
bool IsElementDirtyForPhase(Phase) const;
// This is a backpointer to the context, which should always outlive this
// budget, so it's untraced.
UntracedMember<DisplayLockContext> context_;
} // namespace blink