blob: b0e9488eeba5ce9bc8ce4a13a96b071d18e2a372 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* This file defines the <code>PPB_MouseLock</code> interface for
* locking the target of mouse events to a specific module instance.
*/
[generate_thunk]
label Chrome {
M16 = 1.0
};
/**
* The <code>PPB_MouseLock</code> interface is implemented by the browser.
* This interface provides a way of locking the target of mouse events to a
* single module instance and removing the cursor from view. This mode is
* useful for certain classes of applications, especially first-person
* perspective 3D applications and 3D modeling software.
*/
interface PPB_MouseLock {
/**
* LockMouse() requests the mouse to be locked.
*
* While the mouse is locked, the cursor is implicitly hidden from the user.
* Any movement of the mouse will generate a
* <code>PP_INPUTEVENT_TYPE_MOUSEMOVE</code> event. The
* <code>GetPosition()</code> function in the <code>PPB_MouseInputEvent</code>
* interface reports the last known mouse position just as mouse lock was
* entered. The <code>GetMovement()</code> function provides relative movement
* information indicating what the change in position of the mouse would be
* had it not been locked.
*
* The browser may revoke the mouse lock for reasons including (but not
* limited to) the user pressing the ESC key, the user activating another
* program using a reserved keystroke (e.g. ALT+TAB), or some other system
* event.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>.
*/
int32_t LockMouse([in] PP_Instance instance,
[in] PP_CompletionCallback callback);
/**
* UnlockMouse() causes the mouse to be unlocked, allowing it to track user
* movement again. This is an asynchronous operation. The module instance
* will be notified using the <code>PPP_MouseLock</code> interface when it
* has lost the mouse lock.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module.
*/
void UnlockMouse([in] PP_Instance instance);
};
|
