ppapi/api/private/ppb_flash_fullscreen.idl

   1 /* Copyright (c) 2012 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_FlashFullscreen</code> interface.
   9  */
  10
  11 label Chrome {
  12   M16 = 0.1,
  13   M23 = 1.0
  14 };
  15
  16 interface PPB_FlashFullscreen {
  17   /**
  18    * Checks whether the plugin instance is currently in fullscreen mode.
  19    */
  20   PP_Bool IsFullscreen(
  21       [in] PP_Instance instance);
  22
  23   /*
  24    * This older version required that graphics contexts be recreated after the
  25    * transition.
  26    */
  27   [version=0.1, deprecate=1.0]
  28   PP_Bool SetFullscreen(
  29       [in] PP_Instance instance,
  30       [in] PP_Bool fullscreen);
  31
  32   /**
  33    * Switches the plugin instance to/from fullscreen mode. Returns PP_TRUE on
  34    * success, PP_FALSE on failure.
  35    *
  36    * This does not unbind the current Graphics2D or Graphics3D. Pending flushes
  37    * and swapbuffers will execute as if the resource was off-screen. The
  38    * transition is asynchronous. During the transition, IsFullscreen will
  39    * return PP_FALSE, and no Graphics2D or Graphics3D can be bound. The
  40    * transition ends at the next DidChangeView when going into fullscreen mode.
  41    * The transition out of fullscreen mode is synchronous.
  42    */
  43   [version=1.0]
  44   PP_Bool SetFullscreen(
  45       [in] PP_Instance instance,
  46       [in] PP_Bool fullscreen);
  47
  48   /**
  49    * Gets the size of the screen in pixels. When going fullscreen, the instance
  50    * will be resized to that size.
  51    */
  52   PP_Bool GetScreenSize(
  53       [in] PP_Instance instance,
  54       [out] PP_Size size);
  55 };
  56