OLD | NEW |
1 /* Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2011 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 | 5 |
6 /* From ppb_mouse_lock.idl modified Fri Oct 14 18:59:25 2011. */ | 6 /* From ppb_mouse_lock.idl modified Tue Oct 18 16:19:04 2011. */ |
7 | 7 |
8 #ifndef PPAPI_C_PPB_MOUSE_LOCK_H_ | 8 #ifndef PPAPI_C_PPB_MOUSE_LOCK_H_ |
9 #define PPAPI_C_PPB_MOUSE_LOCK_H_ | 9 #define PPAPI_C_PPB_MOUSE_LOCK_H_ |
10 | 10 |
11 #include "ppapi/c/pp_completion_callback.h" | 11 #include "ppapi/c/pp_completion_callback.h" |
12 #include "ppapi/c/pp_instance.h" | 12 #include "ppapi/c/pp_instance.h" |
13 #include "ppapi/c/pp_macros.h" | 13 #include "ppapi/c/pp_macros.h" |
14 #include "ppapi/c/pp_stdint.h" | 14 #include "ppapi/c/pp_stdint.h" |
15 | 15 |
16 #define PPB_MOUSELOCK_INTERFACE_1_0 "PPB_MouseLock;1.0" | 16 #define PPB_MOUSELOCK_INTERFACE_1_0 "PPB_MouseLock;1.0" |
17 #define PPB_MOUSELOCK_INTERFACE PPB_MOUSELOCK_INTERFACE_1_0 | 17 #define PPB_MOUSELOCK_INTERFACE PPB_MOUSELOCK_INTERFACE_1_0 |
18 | 18 |
19 /** | 19 /** |
20 * @file | 20 * @file |
21 * This file defines the <code>PPB_MouseLock</code> interface. | 21 * This file defines the <code>PPB_MouseLock</code> interface. |
22 */ | 22 */ |
23 | 23 |
24 | 24 |
25 /** | 25 /** |
26 * @addtogroup Interfaces | 26 * @addtogroup Interfaces |
27 * @{ | 27 * @{ |
28 */ | 28 */ |
29 /** | 29 /** |
30 * The <code>PPB_MouseLock</code> interface is implemented by the browser. | 30 * The <code>PPB_MouseLock</code> interface is implemented by the browser. |
31 * It provides a way of locking the target of mouse events to a single plugin | 31 * It provides a way of locking the target of mouse events to a single plugin |
32 * instance and removing the cursor from view. This is a useful input mode for | 32 * instance and removing the cursor from view. This is a useful input mode for |
33 * certain classes of applications, especially first person perspective 3D | 33 * certain classes of applications, especially first person perspective 3D |
34 * applications and 3D modelling software. | 34 * applications and 3D modelling software. |
35 */ | 35 */ |
36 struct PPB_MouseLock { | 36 struct PPB_MouseLock_1_0 { |
37 /** | 37 /** |
38 * Requests the mouse to be locked. The browser will permit mouse lock only | 38 * Requests the mouse to be locked. The browser will permit mouse lock only |
39 * while the tab is in fullscreen mode. | 39 * while the tab is in fullscreen mode. |
40 * | 40 * |
41 * While the mouse is locked, the cursor is implicitly hidden from the user. | 41 * While the mouse is locked, the cursor is implicitly hidden from the user. |
42 * Any movement of the mouse will generate a | 42 * Any movement of the mouse will generate a |
43 * <code>PP_INPUTEVENT_TYPE_MOUSEMOVE</code>. The <code>GetPosition</code> of | 43 * <code>PP_INPUTEVENT_TYPE_MOUSEMOVE</code>. The <code>GetPosition</code> of |
44 * <code>PPB_MouseInputEvent</code> reports the last known mouse position just | 44 * <code>PPB_MouseInputEvent</code> reports the last known mouse position just |
45 * as mouse lock was entered; while the <code>GetMovement</code> provides | 45 * as mouse lock was entered; while the <code>GetMovement</code> provides |
46 * relative movement information, which indicates what the change in position | 46 * relative movement information, which indicates what the change in position |
(...skipping 15 matching lines...) Expand all Loading... |
62 /** | 62 /** |
63 * Causes the mouse to be unlocked, allowing it to track user movement again. | 63 * Causes the mouse to be unlocked, allowing it to track user movement again. |
64 * This is an asynchronous operation. The plugin instance will be notified via | 64 * This is an asynchronous operation. The plugin instance will be notified via |
65 * the <code>PPP_MouseLock</code> interface when it has lost the mouse lock. | 65 * the <code>PPP_MouseLock</code> interface when it has lost the mouse lock. |
66 * | 66 * |
67 * @param[in] instance A <code>PP_Instance</code> identifying one instance | 67 * @param[in] instance A <code>PP_Instance</code> identifying one instance |
68 * of a module. | 68 * of a module. |
69 */ | 69 */ |
70 void (*UnlockMouse)(PP_Instance instance); | 70 void (*UnlockMouse)(PP_Instance instance); |
71 }; | 71 }; |
| 72 |
| 73 typedef struct PPB_MouseLock_1_0 PPB_MouseLock; |
72 /** | 74 /** |
73 * @} | 75 * @} |
74 */ | 76 */ |
75 | 77 |
76 #endif /* PPAPI_C_PPB_MOUSE_LOCK_H_ */ | 78 #endif /* PPAPI_C_PPB_MOUSE_LOCK_H_ */ |
77 | 79 |
OLD | NEW |