ppapi/api/ppb_fullscreen.idl

   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
   3  * found in the LICENSE file.
   4  */
   5
   6
   7 /**
   8  * This file defines the <code>PPB_Fullscreen</code> interface.
   9  */
  10
  11 label Chrome {
  12   M16 = 1.0
  13 };
  14
  15 interface PPB_Fullscreen {
  16   /**
  17    * Checks whether the plugin instance is currently in fullscreen mode.
  18    */
  19   PP_Bool IsFullscreen(
  20       [in] PP_Instance instance);
  21
  22   /**
  23    * Switches the plugin instance to/from fullscreen mode. Returns PP_TRUE on
  24    * success, PP_FALSE on failure.
  25    *
  26    * The transition to and from fullscreen is asynchronous.
  27    * During the transition, IsFullscreen will return the original value, and
  28    * no 2D or 3D device can be bound. The transition ends at DidChangeView
  29    * when IsFullscreen returns the new value. You might receive other
  30    * DidChangeView calls while in transition.
  31    *
  32    * The transition to fullscreen can only occur while the browser is
  33    * processing a user gesture, even if PP_TRUE is returned.
  34    */
  35   PP_Bool SetFullscreen(
  36       [in] PP_Instance instance,
  37       [in] PP_Bool fullscreen);
  38
  39   /**
  40    * Gets the size of the screen in pixels. When going fullscreen, the instance
  41    * will be resized to that size.
  42    */
  43   PP_Bool GetScreenSize(
  44       [in] PP_Instance instance,
  45       [out] PP_Size size);
  46 };
  47