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