OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
dmichael (off chromium)
2012/01/09 20:08:24
I think you need to leave this 2012
jond
2012/01/11 21:48:53
Done.
| |
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 PPAPI_CPP_FULLSCREEN_H_ | 5 #ifndef PPAPI_CPP_FULLSCREEN_H_ |
6 #define PPAPI_CPP_FULLSCREEN_H_ | 6 #define PPAPI_CPP_FULLSCREEN_H_ |
7 | 7 |
8 /// @file | 8 /// @file |
9 /// This file defines the API for handling transitions of a module instance to | 9 /// This file defines the API for handling transitions of a module instance to |
10 /// and from fullscreen mode. | 10 /// and from fullscreen mode. |
11 | 11 |
(...skipping 11 matching lines...) Expand all Loading... | |
23 /// <code>Fullscreen</code>. | 23 /// <code>Fullscreen</code>. |
24 Fullscreen(Instance* instance); | 24 Fullscreen(Instance* instance); |
25 | 25 |
26 /// Destructor. | 26 /// Destructor. |
27 virtual ~Fullscreen(); | 27 virtual ~Fullscreen(); |
28 | 28 |
29 /// IsFullscreen() checks whether the module instance is currently in | 29 /// IsFullscreen() checks whether the module instance is currently in |
30 /// fullscreen mode. | 30 /// fullscreen mode. |
31 /// | 31 /// |
32 /// @return <code>true</code> if the module instance is in fullscreen mode, | 32 /// @return <code>true</code> if the module instance is in fullscreen mode, |
33 ///<code>false</code> if the module instance is not in fullscreen mode. | 33 /// <code>false</code> if the module instance is not in fullscreen mode. |
34 bool IsFullscreen(); | 34 bool IsFullscreen(); |
35 | 35 |
36 /// SetFullscreen() switches the module instance to and from fullscreen | 36 /// SetFullscreen() switches the module instance to and from fullscreen |
37 /// mode. | 37 /// mode. |
38 /// | 38 /// |
39 /// The transition to and from fullscreen mode is asynchronous. During the | 39 /// The transition to and from fullscreen mode is asynchronous. During the |
40 /// transition, IsFullscreen() will return the previous value and | 40 /// transition, IsFullscreen() will return the previous value and |
41 /// no 2D or 3D device can be bound. The transition ends at DidChangeView() | 41 /// no 2D or 3D device can be bound. The transition ends at DidChangeView() |
42 /// when IsFullscreen() returns the new value. You might receive other | 42 /// when IsFullscreen() returns the new value. You might receive other |
43 /// DidChangeView() calls while in transition. | 43 /// DidChangeView() calls while in transition. |
44 /// | 44 /// |
45 /// The transition to fullscreen mode can only occur while the browser is | 45 /// The transition to fullscreen mode can only occur while the browser is |
46 /// processing a user gesture, even if <code>true</code> is returned. | 46 /// processing a user gesture, even if <code>true</code> is returned. |
47 /// | 47 /// |
48 /// @param[in] fullscreen <code>true</code> to enter fullscreen mode, or | 48 /// @param[in] fullscreen <code>true</code> to enter fullscreen mode, or |
49 /// <code>false</code> to exit fullscreen mode. | 49 /// <code>false</code> to exit fullscreen mode. |
50 /// | 50 /// |
51 ///@return <code>true</code> on success or <code>false</code> on | 51 /// @return <code>true</code> on success or <code>false</code> on |
52 /// failure. | 52 /// failure. |
53 bool SetFullscreen(bool fullscreen); | 53 bool SetFullscreen(bool fullscreen); |
54 | 54 |
55 /// GetScreenSize() gets the size of the screen in pixels. The module instance | 55 /// GetScreenSize() gets the size of the screen in pixels. The module instance |
56 /// will be resized to this size when SetFullscreen() is called to enter | 56 /// will be resized to this size when SetFullscreen() is called to enter |
57 /// fullscreen mode. | 57 /// fullscreen mode. |
58 /// | 58 /// |
59 /// @param[out] size The size of the entire screen in pixels. | 59 /// @param[out] size The size of the entire screen in pixels. |
60 /// | 60 /// |
61 /// @return <code>true</code> on success or <code>false</code> on | 61 /// @return <code>true</code> on success or <code>false</code> on |
62 /// failure. | 62 /// failure. |
63 bool GetScreenSize(Size* size); | 63 bool GetScreenSize(Size* size); |
64 | 64 |
65 private: | 65 private: |
66 Instance* instance_; | 66 Instance* instance_; |
67 }; | 67 }; |
68 | 68 |
69 } // namespace pp | 69 } // namespace pp |
70 | 70 |
71 #endif // PPAPI_CPP_FULLSCREEN_H_ | 71 #endif // PPAPI_CPP_FULLSCREEN_H_ |
OLD | NEW |