Mus+Ash: Towards Unifying CompositorFrameSink terminology

cc/ipc/mojo_compositor_frame_sink.mojom

 // Copyright 2016 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.
 
 module cc.mojom;
 
 import "cc/ipc/compositor_frame.mojom";
 import "cc/ipc/returned_resource.mojom";
 
 // A MojoCompositorFrameSink is an interface for receiving CompositorFrame
 // structs. A CompositorFrame contains the complete output meant for display.
 // Each time a client has a graphical update, and receives an OnBeginFrame, it
 // is responsible for creating a CompositorFrame to update its portion of the
 // screen.
 interface MojoCompositorFrameSink {
-  // After the submitted frame is either drawn for the first time by the display
-  // compositor or discarded, the callback will be called. Clients should use
-  // this acknowledgement to ratelimit frame submissions.
-  // TODO(fsamuel): We should support identifying the CF in the callback.
-  SubmitCompositorFrame(cc.mojom.CompositorFrame frame) => ();
-
   // Lets the display compositor know that the client wishes to receive the next
   // BeginFrame event.
   SetNeedsBeginFrame(bool needs_begin_frame);
 
+  // For successful swaps, the implementation must call

[rjkroege, 2016/10/20 21:33:17]

this is top level documentation for how to use the DisplayCompositor. It is
"the" DisplayCompositor API. More better docs please.

[Fady Samuel, 2016/10/20 23:04:10]

Added more details.

+  // DidReceiveCompositorFrameAck() asynchronously when the frame has been
+  // processed in order to unthrottle the next frame.
+  SubmitCompositorFrame(cc.mojom.CompositorFrame frame);
+
   // TODO(fsamuel): ReadbackBitmap API would be useful here.
 };
 
 interface MojoCompositorFrameSinkClient {
-  ReturnResources(ReturnedResourceArray resources);
+  // 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.
+  DidReceiveCompositorFrameAck();

[rjkroege, 2016/10/20 21:33:17]

why do we have this given UBF? Let the compositor simply ask for when it wants
CFRs? This seems unnecessary.

[Fady Samuel, 2016/10/20 23:04:10]

Added TODO.

+
+  // Returns resources sent to SubmitCompositorFrame to be reused or freed.
+  ReclaimResources(ReturnedResourceArray resources);
 };