blob: 61c7830406269e3ecc541ea5c045d40a4d7f532b [file] [log] [blame]
// Copyright 2014 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/macros.h"
#include "cc/cc_export.h"
#include "cc/layers/deadline_policy.h"
#include "cc/layers/layer.h"
#include "components/viz/common/surfaces/surface_info.h"
#include "components/viz/common/surfaces/surface_range.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/geometry/size.h"
namespace cc {
// If given true, we should submit frames, as we are unoccluded on screen.
// If given false, we should not submit compositor frames.
using UpdateSubmissionStateCB = base::RepeatingCallback<void(bool is_visible)>;
// A layer that renders a surface referencing the output of another compositor
// instance or client.
class CC_EXPORT SurfaceLayer : public Layer {
static scoped_refptr<SurfaceLayer> Create();
static scoped_refptr<SurfaceLayer> Create(UpdateSubmissionStateCB);
void SetSurfaceId(const viz::SurfaceId& surface_id,
const DeadlinePolicy& deadline_policy);
void SetOldestAcceptableFallback(const viz::SurfaceId& surface_id);
// When stretch_content_to_fill_bounds is true, the scale of the embedded
// surface is ignored and the content will be stretched to fill the bounds.
void SetStretchContentToFillBounds(bool stretch_content_to_fill_bounds);
bool stretch_content_to_fill_bounds() const {
return stretch_content_to_fill_bounds_;
void SetSurfaceHitTestable(bool surface_hit_testable);
void SetHasPointerEventsNone(bool has_pointer_events_none);
void SetMayContainVideo(bool);
// Layer overrides.
std::unique_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl) override;
void SetLayerTreeHost(LayerTreeHost* host) override;
void PushPropertiesTo(LayerImpl* layer) override;
const viz::SurfaceId& surface_id() const { return surface_range_.end(); }
const base::Optional<viz::SurfaceId>& oldest_acceptable_fallback() const {
return surface_range_.start();
base::Optional<uint32_t> deadline_in_frames() const {
return deadline_in_frames_;
explicit SurfaceLayer(UpdateSubmissionStateCB);
bool HasDrawableContent() const override;
~SurfaceLayer() override;
UpdateSubmissionStateCB update_submission_state_callback_;
bool may_contain_video_ = false;
viz::SurfaceRange surface_range_;
base::Optional<uint32_t> deadline_in_frames_ = 0u;
bool stretch_content_to_fill_bounds_ = false;
// Whether or not the surface should submit hit test data when submitting
// compositor frame. The bit represents that the surface layer may be
// associated with an out-of-process iframe and viz hit testing needs to know
// the hit test information of that iframe. This bit is different from a layer
// being hit testable in the renderer, a hit testable surface layer may not
// be surface hit testable (e.g., a surface layer created by video).
bool surface_hit_testable_ = false;
// Whether or not the surface can accept pointer events. It is set to true if
// the frame owner has pointer-events: none property.
// TODO(sunxd): consider renaming it to oopif_has_pointer_events_none_ for
// disambiguation.
bool has_pointer_events_none_ = false;
} // namespace cc