OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 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 #ifndef CC_BASE_SWAP_PROMISE_H_ | 5 #ifndef CC_BASE_SWAP_PROMISE_H_ |
6 #define CC_BASE_SWAP_PROMISE_H_ | 6 #define CC_BASE_SWAP_PROMISE_H_ |
7 | 7 |
| 8 #include "cc/output/compositor_frame_metadata.h" |
| 9 |
8 namespace cc { | 10 namespace cc { |
9 | 11 |
10 const unsigned int kMaxQueuedSwapPromiseNumber = 100; | 12 const unsigned int kMaxQueuedSwapPromiseNumber = 100; |
11 | 13 |
12 // When a change to the compositor's state/invalidation/whatever happens, a | 14 // When a change to the compositor's state/invalidation/whatever happens, a |
13 // Swap Promise can be inserted into LayerTreeHost/LayerTreeImpl, to track | 15 // Swap Promise can be inserted into LayerTreeHost/LayerTreeImpl, to track |
14 // whether the compositor's reply to the new state/invaliadtion/whatever is | 16 // whether the compositor's reply to the new state/invaliadtion/whatever is |
15 // completed in the compositor, i.e. the compositor knows it has been sent | 17 // completed in the compositor, i.e. the compositor knows it has been sent |
16 // to its output or not. | 18 // to its output or not. |
17 // | 19 // |
18 // If the new compositor state is sent to the output, SwapPromise::DidSwap() | 20 // If the new compositor state is sent to the output, SwapPromise::DidSwap() |
19 // will be called, and if the compositor fails to send its new state to the | 21 // will be called, and if the compositor fails to send its new state to the |
20 // output, SwapPromise::DidNotSwap() will be called. | 22 // output, SwapPromise::DidNotSwap() will be called. |
21 // | 23 // |
22 // Client wishes to use SwapPromise should have a subclass that defines | 24 // Client wishes to use SwapPromise should have a subclass that defines |
23 // the behavior of DidSwap() and DidNotSwap(). Notice that the promise can | 25 // the behavior of DidSwap() and DidNotSwap(). Notice that the promise can |
24 // be broken at either main or impl thread, e.g. commit fails on main thread, | 26 // be broken at either main or impl thread, e.g. commit fails on main thread, |
25 // new frame data has no actual damage so LayerTreeHostImpl::SwapBuffers() | 27 // new frame data has no actual damage so LayerTreeHostImpl::SwapBuffers() |
26 // bails out early on impl thread, so don't assume that DidSwap() and | 28 // bails out early on impl thread, so don't assume that DidSwap() and |
27 // DidNotSwap() are called at a particular thread. It is better to let the | 29 // DidNotSwap() are called at a particular thread. It is better to let the |
28 // subclass carry thread-safe member data and operate on that member data in | 30 // subclass carry thread-safe member data and operate on that member data in |
29 // DidSwap() and DidNotSwap(). | 31 // DidSwap() and DidNotSwap(). |
30 class SwapPromise { | 32 class CC_EXPORT SwapPromise { |
31 public: | 33 public: |
32 SwapPromise() {} | |
33 virtual ~SwapPromise() {} | |
34 | |
35 enum DidNotSwapReason { | 34 enum DidNotSwapReason { |
36 DID_NOT_SWAP_UNKNOWN, | 35 DID_NOT_SWAP_UNKNOWN, |
37 SWAP_FAILS, | 36 SWAP_FAILS, |
38 COMMIT_FAILS, | 37 COMMIT_FAILS, |
39 SWAP_PROMISE_LIST_OVERFLOW, | 38 SWAP_PROMISE_LIST_OVERFLOW, |
40 }; | 39 }; |
41 | 40 |
42 virtual void DidSwap() = 0; | 41 SwapPromise() {} |
| 42 virtual ~SwapPromise() {} |
| 43 |
| 44 virtual void DidSwap(CompositorFrameMetadata* metadata) = 0; |
43 virtual void DidNotSwap(DidNotSwapReason reason) = 0; | 45 virtual void DidNotSwap(DidNotSwapReason reason) = 0; |
44 }; | 46 }; |
45 | 47 |
46 } // namespace cc | 48 } // namespace cc |
47 | 49 |
48 #endif // CC_BASE_SWAP_PROMISE_H_ | 50 #endif // CC_BASE_SWAP_PROMISE_H_ |
OLD | NEW |