ppapi/api/ppb_mouse_lock.idl

/* Copyright (c) 2011 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.
 */

label Chrome {
  M16 = 1.0
};

/**
 * The <code>PPB_MouseLock</code> interface is implemented by the browser.
 * It provides a way of locking the target of mouse events to a single plugin
 * instance and removing the cursor from view. This is a useful input mode for
 * certain classes of applications, especially first person perspective 3D
 * applications and 3D modelling software.
 */
interface PPB_MouseLock {
  /**
   * Requests the mouse to be locked. The browser will permit mouse lock only
   * while the tab is in fullscreen mode.
   *
   * 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>. The <code>GetPosition</code> of
   * <code>PPB_MouseInputEvent</code> reports the last known mouse position just
   * as mouse lock was entered; while the <code>GetMovement</code> provides
   * relative movement information, which indicates what the change in position
   * of the mouse would be had it not been locked.
   *
   * The browser may revoke mouse lock for reasons including but not limited to
   * the user pressing the ESC key, the user activating another program via 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);

  /**
   * Causes the mouse to be unlocked, allowing it to track user movement again.
   * This is an asynchronous operation. The plugin instance will be notified via
   * 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);
};