cc: Split and comment methods for Display vs LayerTreeHostImpl

cc/output/output_surface.h

 // 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.
 
 #ifndef CC_OUTPUT_OUTPUT_SURFACE_H_
 #define CC_OUTPUT_OUTPUT_SURFACE_H_
 
 #include <deque>
 #include <memory>
 
@@ skipping 68 matching lines @@
     // Whether this OutputSurface is flipped or not.
     bool flipped_output_surface;
     // Whether ForceReclaimResources can be called to reclaim all resources
     // from the OutputSurface.
     bool can_force_reclaim_resources;
     // True if sync points for resources are needed when swapping delegated
     // frames.
     bool delegated_sync_points_required;
   };
 
-  const Capabilities& capabilities() const {
-    return capabilities_;
-  }
-
-  virtual bool HasExternalStencilTest() const;
-  virtual void ApplyExternalStencil();
-
-  // Obtain the 3d context or the software device associated with this output
-  // surface. Either of these may return a null pointer, but not both.
-  // In the event of a lost context, the entire output surface should be
-  // recreated.
-  ContextProvider* context_provider() const { return context_provider_.get(); }
-  ContextProvider* worker_context_provider() const {
-    return worker_context_provider_.get();
-  }
-  VulkanContextProvider* vulkan_context_provider() const {
-    return vulkan_context_provider_.get();
-  }
-  SoftwareOutputDevice* software_device() const {
-    return software_device_.get();
-  }
-
-  // Called by the compositor on the compositor thread. This is a place where
-  // thread-specific data for the output surface can be initialized, since from
-  // this point to when DetachFromClient() is called the output surface will
-  // only be used on the compositor thread.
-  // The caller should call DetachFromClient() on the same thread before
-  // destroying the OutputSurface, even if this fails. And BindToClient should
-  // not be called twice for a given OutputSurface.
-  virtual bool BindToClient(OutputSurfaceClient* client);
-
-  // Called by the compositor on the compositor thread. This is a place where
-  // thread-specific data for the output surface can be uninitialized.
-  virtual void DetachFromClient();
+  // ============== DISPLAY COMPOSITOR ONLY =======================
 
   virtual void EnsureBackbuffer();
   virtual void DiscardBackbuffer();
 
-  virtual void Reshape(const gfx::Size& size,
-                       float scale_factor,
-                       const gfx::ColorSpace& color_space,
-                       bool alpha);
-  gfx::Size SurfaceSize() const { return surface_size_; }
-  float device_scale_factor() const { return device_scale_factor_; }
   const gfx::ColorSpace& device_color_space() const {
     return device_color_space_;
   }
 
-  // If supported, this causes a ReclaimResources for all resources that are
-  // currently in use.
-  virtual void ForceReclaimResources() {}
-
-  virtual void BindFramebuffer();
-  // Gives the GL internal format that should be used for calling CopyTexImage2D
-  // when the framebuffer is bound via BindFramebuffer().
-  virtual uint32_t GetFramebufferCopyTextureFormat() = 0;
-
-  // The implementation may destroy or steal the contents of the CompositorFrame
-  // passed in (though it will not take ownership of the CompositorFrame
-  // itself). For successful swaps, the implementation must call
-  // DidSwapBuffersComplete() (via OnSwapBuffersComplete()) eventually.
-  virtual void SwapBuffers(CompositorFrame frame) = 0;
-  virtual void OnSwapBuffersComplete();
-
   // Called by subclasses after receiving a response from the gpu process to a
   // query about whether a given set of textures is still in use by the OS
   // compositor.
   void DidReceiveTextureInUseResponses(
       const gpu::TextureInUseResponses& responses);
 
-  bool HasClient() { return !!client_; }
-
   // Get the class capable of informing cc of hardware overlay capability.
   virtual OverlayCandidateValidator* GetOverlayCandidateValidator() const;
 
   // Returns true if a main image overlay plane should be scheduled.
   virtual bool IsDisplayedAsOverlayPlane() const;
 
   // Get the texture for the main image's overlay.
   virtual unsigned GetOverlayTextureId() const;
 
-  virtual void DidLoseOutputSurface();
+  // If this returns true, then the surface will not attempt to draw.
+  virtual bool SurfaceIsSuspendForRecycle() const;
+
+  virtual void Reshape(const gfx::Size& size,
+                       float scale_factor,
+                       const gfx::ColorSpace& color_space,
+                       bool alpha);
+  gfx::Size SurfaceSize() const { return surface_size_; }
+
+  virtual void ApplyExternalStencil();
+  virtual bool HasExternalStencilTest() const;
+
+  // ============== CONTENT COLLATOR ONLY =========================

[enne (OOO), 2016/09/12 18:25:20]

Maybe just call this ContentFrameSink only? I know I know, but content collator
maybe should just stay a joke and not enter the codebase for real.  Even content
compositor is slightly better.

<_<

+
+  // If supported, this causes a ReclaimResources for all resources that are
+  // currently in use.
+  virtual void ForceReclaimResources() {}
+
+  virtual void BindFramebuffer();
+  // Gives the GL internal format that should be used for calling CopyTexImage2D
+  // when the framebuffer is bound via BindFramebuffer().
+  virtual uint32_t GetFramebufferCopyTextureFormat() = 0;
 
   // Support for a pull-model where draws are requested by the output surface.
   //
   // OutputSurface::Invalidate is called by the compositor to notify that
   // there's new content.
   virtual void Invalidate() {}
 
-  // If this returns true, then the surface will not attempt to draw.
-  virtual bool SurfaceIsSuspendForRecycle() const;
+  // ============== BOTH TYPES OF COMPOSITOR ======================
+
+  // Called by the compositor on the compositor thread. This is a place where
+  // thread-specific data for the output surface can be initialized, since from
+  // this point to when DetachFromClient() is called the output surface will
+  // only be used on the compositor thread.
+  // The caller should call DetachFromClient() on the same thread before
+  // destroying the OutputSurface, even if this fails. And BindToClient should
+  // not be called twice for a given OutputSurface.
+  virtual bool BindToClient(OutputSurfaceClient* client);
+
+  // Called by the compositor on the compositor thread. This is a place where
+  // thread-specific data for the output surface can be uninitialized.
+  virtual void DetachFromClient();
+
+  bool HasClient() { return !!client_; }
+
+  const Capabilities& capabilities() const { return capabilities_; }
+
+  // Obtain the 3d context or the software device associated with this output
+  // surface. Either of these may return a null pointer, but not both.
+  // In the event of a lost context, the entire output surface should be
+  // recreated.
+  ContextProvider* context_provider() const { return context_provider_.get(); }
+  ContextProvider* worker_context_provider() const {
+    return worker_context_provider_.get();
+  }
+  VulkanContextProvider* vulkan_context_provider() const {
+    return vulkan_context_provider_.get();
+  }
+  SoftwareOutputDevice* software_device() const {
+    return software_device_.get();
+  }
+
+  // The implementation may destroy or steal the contents of the CompositorFrame
+  // passed in (though it will not take ownership of the CompositorFrame
+  // itself). For successful swaps, the implementation must call
+  // DidSwapBuffersComplete() (via OnSwapBuffersComplete()) eventually.
+  virtual void SwapBuffers(CompositorFrame frame) = 0;
+  virtual void OnSwapBuffersComplete();
+
+  // This is how LayerTreeHostImpl hears about context loss when the Display
+  // is the one listening for context loss. Also used internally for the
+  // context provider to inform the LayerTreeHostImpl or Display about loss.
+  // It would become display-compositor-only when LayerTreeHostImpl receives
+  // its contexts independently from the "OutputSurface".
+  // TODO(danakj): Be private. Subclasses should just call the client directly.
+  virtual void DidLoseOutputSurface();
 
   // base::trace_event::MemoryDumpProvider implementation.
   bool OnMemoryDump(const base::trace_event::MemoryDumpArgs& args,
                     base::trace_event::ProcessMemoryDump* pmd) override;
 
  protected:
+  // ============== DISPLAY COMPOSITOR ONLY =======================
+
+  // Used by WebView for the display compositor only.
+  // TODO(danakj): This should go away, store the state in the subclass that
+  // uses this.
+  void SetExternalStencilTest(bool enabled);
+
+  // ============== BOTH TYPES OF COMPOSITOR ======================
+
+  // This is used by both display and delegating implementations.
   void PostSwapBuffersComplete();
+  // TODO(danakj): Delete this. Subclasses should just call the client directly.
+  void SetNeedsRedrawRect(const gfx::Rect& damage_rect);
+  // TODO(danakj): Delete this. Subclasses should just call the client directly.
+  void ReclaimResources(const ReturnedResourceArray& resources);
 
   OutputSurfaceClient* client_ = nullptr;
 
   struct OutputSurface::Capabilities capabilities_;
   scoped_refptr<ContextProvider> context_provider_;
   scoped_refptr<ContextProvider> worker_context_provider_;
   scoped_refptr<VulkanContextProvider> vulkan_context_provider_;
   std::unique_ptr<SoftwareOutputDevice> software_device_;
   gfx::Size surface_size_;
   float device_scale_factor_ = -1;
   gfx::ColorSpace device_color_space_;
   bool has_alpha_ = true;
   gfx::ColorSpace color_space_;
   base::ThreadChecker client_thread_checker_;
 
-  void SetNeedsRedrawRect(const gfx::Rect& damage_rect);
-  void ReclaimResources(const ReturnedResourceArray& resources);
-  void SetExternalStencilTest(bool enabled);
+ private:
   void DetachFromClientInternal();
 
- private:
   bool external_stencil_test_enabled_ = false;
-
   base::WeakPtrFactory<OutputSurface> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(OutputSurface);
 };
 
 }  // namespace cc
 
 #endif  // CC_OUTPUT_OUTPUT_SURFACE_H_