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 ui.gpu.mojom; | 5 module ui.gpu.mojom; |
6 | 6 |
7 import "cc/ipc/compositor_frame.mojom"; | 7 import "cc/ipc/compositor_frame.mojom"; |
8 import "cc/ipc/returned_resource.mojom"; | 8 import "cc/ipc/returned_resource.mojom"; |
9 | 9 |
10 // A CompositorFrameSinkFactory represents a single Display client. | 10 // A CompositorFrameSinkFactory represents a single Display client. |
11 // The client (a process) can use this interface to create | 11 // The client (a process) can use this interface to create |
12 // CompositorFrameSinks. | 12 // CompositorFrameSinks. |
13 // TODO(fsamuel): This needs a better name. | 13 // TODO(fsamuel): This needs a better name. |
14 interface CompositorFrameSinkFactory { | 14 interface CompositorFrameSinkFactory { |
15 // Requests a CompositorFrameSink interface from the display compositor. | 15 // Requests a CompositorFrameSink interface from the display compositor. |
16 // A CompositorFrameSink has an associated ID consisting of three components: | 16 // A CompositorFrameSink has an associated ID consisting of three components: |
17 // 1. Namespace picked by the service associated with this | 17 // 1. Namespace picked by the service associated with this |
18 // CompositorFrameSinkFactory. | 18 // CompositorFrameSinkFactory. |
19 // 2. |local_id| which is a monotonically increasing ID allocated by the | 19 // 2. |local_id| which is a monotonically increasing ID allocated by the |
20 // client. | 20 // client. |
21 // 3. |nonce| is a cryptographically secure random number making this Sink | 21 // 3. |nonce| is a cryptographically secure random number making this Sink |
22 // unguessable by other clients. | 22 // unguessable by other clients. |
23 CreateCompositorFrameSink(uint32 local_id, | 23 CreateCompositorFrameSink(uint32 local_id, |
24 uint64 nonce, | 24 uint64 nonce, |
25 CompositorFrameSink& sink, | 25 CompositorFrameSink& sink, |
26 CompositorFrameSinkClient client); | 26 CompositorFrameSinkClient client); |
27 }; | 27 }; |
28 | 28 |
29 // A CompositorFrameSink is an interface for receiving CompositorFrame structs. | |
30 // A CompositorFrame contains the complete output meant for display. Each time a | |
31 // client has a graphical update, and receives an OnBeginFrame, it is | |
32 // responsible for creating a CompositorFrame to update its portion of the | |
33 // screen. | |
34 interface CompositorFrameSink { | |
35 // After the submitted frame is either drawn for the first time by the display | |
36 // compositor or discarded, the callback will be called. Clients should use | |
37 // this acknowledgement to ratelimit frame submissions. | |
38 // TODO(fsamuel): We should support identifying the CF in the callback. | |
39 SubmitCompositorFrame(cc.mojom.CompositorFrame frame) => (); | |
40 | |
41 // Lets the display compositor know that the client wishes to receive the next | |
42 // BeginFrame event. | |
43 SetNeedsBeginFrame(bool needs_begin_frame); | |
44 | |
45 // TODO(fsamuel): ReadbackBitmap API would be useful here. | |
46 }; | |
47 | |
48 interface CompositorFrameSinkClient { | |
49 ReturnResources(array<cc.mojom.ReturnedResource> resources); | |
50 }; | |
51 | |
52 // This is a public interface implemented by Display clients. | 29 // This is a public interface implemented by Display clients. |
53 // Each client implements a single instance of the DisplayClient interface. | 30 // Each client implements a single instance of the DisplayClient interface. |
54 interface DisplayClient { | 31 interface DisplayClient { |
55 // Clients can register CompositorFrameSinks via the provided |factory|. | 32 // Clients can register CompositorFrameSinks via the provided |factory|. |
56 OnClientCreated(uint32 client_id, CompositorFrameSinkFactory factory); | 33 OnClientCreated(uint32 client_id, CompositorFrameSinkFactory factory); |
57 | 34 |
58 // TODO(fsamuel): OnBeginFrame needs to take a BeginFrameArgs instance per | 35 // TODO(fsamuel): OnBeginFrame needs to take a BeginFrameArgs instance per |
59 // cc/output/begin_frame_args.h. | 36 // cc/output/begin_frame_args.h. |
60 OnBeginFrame(); | 37 OnBeginFrame(); |
61 }; | 38 }; |
OLD | NEW |