Rename SurfaceLayer::hit_testable_ to surface_hit_testable_

We want to propagate pointer-events: none information to cc to generate
correct hit testing data for viz. The plan is to have blink set the hit
testable bit on cc::Layers. In order to disambiguate the bit in surface
layer that represents the origin of the surface, we want to rename the
variable.

Bug: 841358
Cq-Include-Trybots: luci.chromium.try:android_optional_gpu_tests_rel;master.tryserver.blink:linux_trusty_blink_rel
Change-Id: I207815dcfad0f29b222b0a39c350f1e926aedac9
Reviewed-on: https://chromium-review.googlesource.com/1052506Reviewed-by: Bo <boliu@chromium.org>
Reviewed-by: Robert Kroeger <rjkroege@chromium.org>
Reviewed-by: Kentaro Hara <haraken@chromium.org>
Reviewed-by: Robert Flack <flackr@chromium.org>
Commit-Queue: Xianda Sun <sunxd@chromium.org>
Cr-Commit-Position: refs/heads/master@{#558450}

cc/layers/surface_layer.cc

@@ -59,10 +59,10 @@ void SurfaceLayer::SetStretchContentToFillBounds(
   SetNeedsPushProperties();
 }
 
-void SurfaceLayer::SetHitTestable(bool hit_testable) {
-  if (hit_testable_ == hit_testable)
+void SurfaceLayer::SetSurfaceHitTestable(bool surface_hit_testable) {
+  if (surface_hit_testable_ == surface_hit_testable)
     return;
-  hit_testable_ = hit_testable;
+  surface_hit_testable_ = surface_hit_testable;
   SetNeedsPushProperties();
 }
 
@@ -100,7 +100,7 @@ void SurfaceLayer::PushPropertiesTo(LayerImpl* layer) {
   deadline_in_frames_ = 0u;
   layer_impl->SetFallbackSurfaceId(fallback_surface_id_);
   layer_impl->SetStretchContentToFillBounds(stretch_content_to_fill_bounds_);
-  layer_impl->SetHitTestable(hit_testable_);
+  layer_impl->SetSurfaceHitTestable(surface_hit_testable_);
 }
 
 }  // namespace cc

cc/layers/surface_layer.h

@@ -32,8 +32,8 @@ class CC_EXPORT SurfaceLayer : public Layer {
     return stretch_content_to_fill_bounds_;
   }
 
-  void SetHitTestable(bool hit_testable);
-  bool hit_testable() const { return hit_testable_; }
+  void SetSurfaceHitTestable(bool surface_hit_testable);
+  bool surface_hit_testable() const { return surface_hit_testable_; }
 
   // Layer overrides.
   std::unique_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl) override;
@@ -64,7 +64,14 @@ class CC_EXPORT SurfaceLayer : public Layer {
   base::Optional<uint32_t> deadline_in_frames_ = 0u;
 
   bool stretch_content_to_fill_bounds_ = false;
-  bool hit_testable_ = 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;
 
   DISALLOW_COPY_AND_ASSIGN(SurfaceLayer);
 };

cc/layers/surface_layer_impl.cc

@@ -54,11 +54,11 @@ void SurfaceLayerImpl::SetStretchContentToFillBounds(bool stretch_content) {
   NoteLayerPropertyChanged();
 }
 
-void SurfaceLayerImpl::SetHitTestable(bool hit_testable) {
-  if (hit_testable_ == hit_testable)
+void SurfaceLayerImpl::SetSurfaceHitTestable(bool surface_hit_testable) {
+  if (surface_hit_testable_ == surface_hit_testable)
     return;
 
-  hit_testable_ = hit_testable;
+  surface_hit_testable_ = surface_hit_testable;
   NoteLayerPropertyChanged();
 }
 
@@ -71,7 +71,7 @@ void SurfaceLayerImpl::PushPropertiesTo(LayerImpl* layer) {
   deadline_in_frames_ = 0u;
   layer_impl->SetFallbackSurfaceId(fallback_surface_id_);
   layer_impl->SetStretchContentToFillBounds(stretch_content_to_fill_bounds_);
-  layer_impl->SetHitTestable(hit_testable_);
+  layer_impl->SetSurfaceHitTestable(surface_hit_testable_);
 }
 
 void SurfaceLayerImpl::AppendQuads(viz::RenderPass* render_pass,

cc/layers/surface_layer_impl.h

@@ -50,8 +50,8 @@ class CC_EXPORT SurfaceLayerImpl : public LayerImpl {
     return stretch_content_to_fill_bounds_;
   }
 
-  void SetHitTestable(bool hit_testable);
-  bool hit_testable() const { return hit_testable_; }
+  void SetSurfaceHitTestable(bool surface_hit_testable);
+  bool surface_hit_testable() const { return surface_hit_testable_; }
 
   // LayerImpl overrides.
   std::unique_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl) override;
@@ -79,7 +79,7 @@ class CC_EXPORT SurfaceLayerImpl : public LayerImpl {
   base::Optional<uint32_t> deadline_in_frames_;
 
   bool stretch_content_to_fill_bounds_ = false;
-  bool hit_testable_ = false;
+  bool surface_hit_testable_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(SurfaceLayerImpl);
 };

components/viz/client/hit_test_data_provider_surface_layer.cc

@@ -75,7 +75,7 @@ mojom::HitTestRegionListPtr HitTestDataProviderSurfaceLayer::GetHitTestData(
       const auto* surface_layer =
           static_cast<const cc::SurfaceLayerImpl*>(layer);
 
-      if (!surface_layer->hit_testable()) {
+      if (!surface_layer->surface_hit_testable()) {
         overlapping_region.Union(cc::MathUtil::MapEnclosingClippedRect(
             layer->ScreenSpaceTransform(), gfx::Rect(surface_layer->bounds())));
         continue;

components/viz/client/hit_test_data_provider_surface_layer_unittest.cc

@@ -73,12 +73,12 @@ TEST(HitTestDataProviderSurfaceLayerTest, HitTestDataRenderer) {
   rotate.Rotate(45);
   surface_child1->test_properties()->transform = rotate;
   surface_child1->SetDrawsContent(true);
-  surface_child1->SetHitTestable(true);
+  surface_child1->SetSurfaceHitTestable(true);
 
   surface_child2->SetPosition(gfx::PointF(450, 300));
   surface_child2->SetBounds(gfx::Size(100, 100));
   surface_child2->SetDrawsContent(true);
-  surface_child2->SetHitTestable(true);
+  surface_child2->SetSurfaceHitTestable(true);
 
   overlapping_layer->SetPosition(gfx::PointF(500, 350));
   overlapping_layer->SetBounds(gfx::Size(200, 200));

content/renderer/child_frame_compositing_helper.cc

@@ -82,7 +82,7 @@ void ChildFrameCompositingHelper::SetPrimarySurfaceId(
 
   surface_layer_ = cc::SurfaceLayer::Create();
   surface_layer_->SetMasksToBounds(true);
-  surface_layer_->SetHitTestable(true);
+  surface_layer_->SetSurfaceHitTestable(true);
   surface_layer_->SetBackgroundColor(SK_ColorTRANSPARENT);
 
   surface_layer_->SetPrimarySurfaceId(surface_id, deadline);

ui/android/delegated_frame_host_android.cc

@@ -50,7 +50,7 @@ scoped_refptr<cc::SurfaceLayer> CreateSurfaceLayer(
   layer->SetBounds(size_in_pixels);
   layer->SetIsDrawable(true);
   layer->SetContentsOpaque(surface_opaque);
-  layer->SetHitTestable(true);
+  layer->SetSurfaceHitTestable(true);
 
   return layer;
 }

ui/compositor/layer.cc

@@ -775,7 +775,7 @@ void Layer::SetShowPrimarySurface(const viz::SurfaceId& surface_id,
 
   if (!surface_layer_) {
     scoped_refptr<cc::SurfaceLayer> new_layer = cc::SurfaceLayer::Create();
-    new_layer->SetHitTestable(true);
+    new_layer->SetSurfaceHitTestable(true);
     SwitchToLayer(new_layer);
     surface_layer_ = new_layer;
   }

ui/compositor/layer_unittest.cc

@@ -905,16 +905,16 @@ TEST_F(LayerWithDelegateTest, SurfaceLayerCloneAndMirror) {
                                cc::DeadlinePolicy::UseDefaultDeadline(), false);
   EXPECT_FALSE(layer->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(layer->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
 
   auto clone = layer->Clone();
   EXPECT_FALSE(clone->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(clone->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
   auto mirror = layer->Mirror();
   EXPECT_FALSE(mirror->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(mirror->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
 
   local_surface_id = allocator.GenerateId();
   viz::SurfaceId surface_id_two(arbitrary_frame_sink, local_surface_id);
@@ -922,16 +922,16 @@ TEST_F(LayerWithDelegateTest, SurfaceLayerCloneAndMirror) {
                                cc::DeadlinePolicy::UseDefaultDeadline(), true);
   EXPECT_TRUE(layer->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(layer->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
 
   clone = layer->Clone();
   EXPECT_TRUE(clone->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(clone->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
   mirror = layer->Mirror();
   EXPECT_TRUE(mirror->StretchContentToFillBounds());
   EXPECT_TRUE(static_cast<cc::SurfaceLayer*>(mirror->cc_layer_for_testing())
-                  ->hit_testable());
+                  ->surface_hit_testable());
 }
 
 class LayerWithNullDelegateTest : public LayerWithDelegateTest {