| OLD | NEW |
| 1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 module cc.mojom; | 5 module cc.mojom; |
| 6 | 6 |
| 7 import "cc/ipc/begin_frame_args.mojom"; | 7 import "cc/ipc/begin_frame_args.mojom"; |
| 8 import "cc/ipc/compositor_frame.mojom"; | 8 import "cc/ipc/compositor_frame.mojom"; |
| 9 import "cc/ipc/frame_sink_id.mojom"; | 9 import "cc/ipc/frame_sink_id.mojom"; |
| 10 import "cc/ipc/local_frame_id.mojom"; | 10 import "cc/ipc/local_frame_id.mojom"; |
| 11 import "cc/ipc/surface_reference.mojom"; |
| 11 import "cc/ipc/returned_resource.mojom"; | 12 import "cc/ipc/returned_resource.mojom"; |
| 12 | 13 |
| 13 // A MojoCompositorFrameSink is an interface for receiving CompositorFrame | 14 // A MojoCompositorFrameSink is an interface for receiving CompositorFrame |
| 14 // structs. A CompositorFrame contains the complete output meant for display. | 15 // structs. A CompositorFrame contains the complete output meant for display. |
| 15 // Each time a client has a graphical update, and receives an OnBeginFrame, it | 16 // Each time a client has a graphical update, and receives an OnBeginFrame, it |
| 16 // is responsible for creating a CompositorFrame to update its portion of the | 17 // is responsible for creating a CompositorFrame to update its portion of the |
| 17 // screen. | 18 // screen. |
| 18 interface MojoCompositorFrameSink { | 19 interface MojoCompositorFrameSink { |
| 19 // Lets the display compositor know that the client wishes to receive the next | 20 // Lets the display compositor know that the client wishes to receive the next |
| 20 // BeginFrame event. | 21 // BeginFrame event. |
| 21 SetNeedsBeginFrame(bool needs_begin_frame); | 22 SetNeedsBeginFrame(bool needs_begin_frame); |
| 22 | 23 |
| 23 // Submits a CompositorFrame to the display compositor that will be presented | 24 // Submits a CompositorFrame to the display compositor that will be presented |
| 24 // to screen the next time frames from all CompositorFrameSinks are aggregated | 25 // to screen the next time frames from all CompositorFrameSinks are aggregated |
| 25 // to produce a display CompositorFrame. If a client wishes to allocate a new | 26 // to produce a display CompositorFrame. If a client wishes to allocate a new |
| 26 // surface (e.g. during resize), then it can simply allocate a new | 27 // surface (e.g. during resize), then it can simply allocate a new |
| 27 // |local_frame_id|. | 28 // |local_frame_id|. |
| 28 // For successful swaps, the implementation must call | 29 // For successful swaps, the implementation must call |
| 29 // DidReceiveCompositorFrameAck() asynchronously when the frame has been | 30 // DidReceiveCompositorFrameAck() asynchronously when the frame has been |
| 30 // processed in order to unthrottle the next frame. | 31 // processed in order to unthrottle the next frame. |
| 31 SubmitCompositorFrame(cc.mojom.LocalFrameId local_frame_id, | 32 SubmitCompositorFrame(cc.mojom.LocalFrameId local_frame_id, |
| 32 cc.mojom.CompositorFrame frame); | 33 cc.mojom.CompositorFrame frame); |
| 33 | 34 |
| 35 // Adds surface references. |
| 36 AddSurfaceReferences(array<SurfaceReference> references); |
| 37 |
| 38 // Removes surface references. |
| 39 RemoveSurfaceReferences(array<SurfaceReference> references); |
| 40 |
| 34 // TODO(fsamuel): ReadbackBitmap API would be useful here. | 41 // TODO(fsamuel): ReadbackBitmap API would be useful here. |
| 35 }; | 42 }; |
| 36 | 43 |
| 37 interface MojoCompositorFrameSinkClient { | 44 interface MojoCompositorFrameSinkClient { |
| 38 // Notification that the previous CompositorFrame given to | 45 // Notification that the previous CompositorFrame given to |
| 39 // SubmitCompositorFrame() has been processed and that another frame | 46 // SubmitCompositorFrame() has been processed and that another frame |
| 40 // can be submitted. This provides backpressure from the display compositor | 47 // can be submitted. This provides backpressure from the display compositor |
| 41 // so that frames are submitted only at the rate it can handle them. | 48 // so that frames are submitted only at the rate it can handle them. |
| 42 // TODO(fsamuel): This method ought not be necessary with unified BeginFrame. | 49 // TODO(fsamuel): This method ought not be necessary with unified BeginFrame. |
| 43 // However, there's a fair amount of cleanup and refactoring necessary to get | 50 // However, there's a fair amount of cleanup and refactoring necessary to get |
| 44 // rid of it. | 51 // rid of it. |
| 45 DidReceiveCompositorFrameAck(); | 52 DidReceiveCompositorFrameAck(); |
| 46 | 53 |
| 47 // Notification for the client to generate a CompositorFrame. | 54 // Notification for the client to generate a CompositorFrame. |
| 48 OnBeginFrame(BeginFrameArgs args); | 55 OnBeginFrame(BeginFrameArgs args); |
| 49 | 56 |
| 50 // Returns resources sent to SubmitCompositorFrame to be reused or freed. | 57 // Returns resources sent to SubmitCompositorFrame to be reused or freed. |
| 51 ReclaimResources(ReturnedResourceArray resources); | 58 ReclaimResources(ReturnedResourceArray resources); |
| 52 }; | 59 }; |
| 53 | 60 |
| 54 // MojoCompositorFrameSinkPrivate is used by the display compositor host to set | 61 // MojoCompositorFrameSinkPrivate is used by the display compositor host to set |
| 55 // up BeginFrameSource hierarchies. This API lives in SurfaceManager but is | 62 // up BeginFrameSource hierarchies. This API lives in SurfaceManager but is |
| 56 // called from here in order to ensure that hierarchy registration does not race | 63 // called from here in order to ensure that hierarchy registration does not race |
| 57 // CompositorFrameSink creation. | 64 // CompositorFrameSink creation. |
| 58 interface MojoCompositorFrameSinkPrivate { | 65 interface MojoCompositorFrameSinkPrivate { |
| 59 AddChildFrameSink(FrameSinkId child_frame_sink_id); | 66 AddChildFrameSink(FrameSinkId child_frame_sink_id); |
| 60 RemoveChildFrameSink(FrameSinkId child_frame_sink_id); | 67 RemoveChildFrameSink(FrameSinkId child_frame_sink_id); |
| 61 }; | 68 }; |
| OLD | NEW |