blob: fc298c8fef547a7ba725c02b416a6c7d4c640ee0 [file] [log] [blame]
// Copyright 2012 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 "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/optional.h"
#include "base/time/time.h"
#include "cc/cc_export.h"
#include "components/viz/common/resources/returned_resource.h"
#include "gpu/command_buffer/common/texture_in_use_response.h"
#include "ui/gfx/geometry/rect.h"
namespace gfx {
struct PresentationFeedback;
class Transform;
namespace viz {
class BeginFrameSource;
struct HitTestRegionList;
namespace cc {
struct ManagedMemoryPolicy;
class CC_EXPORT LayerTreeFrameSinkClient {
// Pass the begin frame source for the client to observe. Client does not own
// the viz::BeginFrameSource. LayerTreeFrameSink should call this once after
// binding to the client and then call again with a null while detaching.
virtual void SetBeginFrameSource(viz::BeginFrameSource* source) = 0;
// Builds and returns a HitTestRegionList from the active LayerTreeImpl. To be
// called during SubmitCompositorFrame().
// TODO(danakj): Just pass it into SubmitCompositorFrame(), with a
// LayerTreeSetting to enable it or not.
virtual base::Optional<viz::HitTestRegionList> BuildHitTestData() = 0;
// Returns resources sent to SubmitCompositorFrame to be reused or freed.
virtual void ReclaimResources(
const std::vector<viz::ReturnedResource>& resources) = 0;
// If set, |callback| will be called subsequent to each new tree activation,
// regardless of the compositor visibility or damage. |callback| must remain
// valid for the lifetime of the LayerTreeFrameSinkClient or until
// unregistered by giving a null callback.
virtual void SetTreeActivationCallback(base::RepeatingClosure callback) = 0;
// Notification that the previous CompositorFrame given to
// SubmitCompositorFrame() has been processed and that another frame
// can be submitted. This provides backpressure from the display compositor
// so that frames are submitted only at the rate it can handle them.
virtual void DidReceiveCompositorFrameAck() = 0;
// See ui/gfx/presentation_feedback.h for details on args. |time| is always
// non-zero.
virtual void DidPresentCompositorFrame(
uint32_t presentation_token,
const gfx::PresentationFeedback& feedback) = 0;
// The LayerTreeFrameSink is lost when the viz::ContextProviders held by it
// encounter an error. In this case the LayerTreeFrameSink (and the
// viz::ContextProviders) must be recreated.
virtual void DidLoseLayerTreeFrameSink() = 0;
// Notification that the client does not need a new BeginFrame.
virtual void DidNotNeedBeginFrame() = 0;
// For SynchronousCompositor (WebView) to ask the layer compositor to submit
// a new CompositorFrame synchronously.
virtual void OnDraw(const gfx::Transform& transform,
const gfx::Rect& viewport,
bool resourceless_software_draw,
bool skip_draw) = 0;
// For SynchronousCompositor (WebView) to set how much memory the compositor
// can use without changing visibility.
virtual void SetMemoryPolicy(const ManagedMemoryPolicy& policy) = 0;
// For SynchronousCompositor (WebView) to change which tiles should be
// included in submitted CompositorFrames independently of what the viewport
// is.
// |viewport_rect| is in device viewport space.
// |transform| transforms from from device viewport space to screen space.
virtual void SetExternalTilePriorityConstraints(
const gfx::Rect& viewport_rect,
const gfx::Transform& transform) = 0;
virtual ~LayerTreeFrameSinkClient() {}
} // namespace cc