summaryrefslogtreecommitdiffstats
path: root/ppapi/c/dev/ppb_fullscreen_dev.h
diff options
context:
space:
mode:
authorbrettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-26 19:44:50 +0000
committerbrettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-26 19:44:50 +0000
commit1649b5b0f8d0e42075a99cefb874f7e53d8527ec (patch)
treeeafe5dca8e21cc6c7241e4b12eb886924f47e60a /ppapi/c/dev/ppb_fullscreen_dev.h
parent814127cb0ef1687e792519a44bfb71580e922e5b (diff)
downloadchromium_src-1649b5b0f8d0e42075a99cefb874f7e53d8527ec.zip
chromium_src-1649b5b0f8d0e42075a99cefb874f7e53d8527ec.tar.gz
chromium_src-1649b5b0f8d0e42075a99cefb874f7e53d8527ec.tar.bz2
Add IDL for the fullscreen dev API and automatically generate the .h file.
Review URL: http://codereview.chromium.org/7740052 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@98465 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c/dev/ppb_fullscreen_dev.h')
-rw-r--r--ppapi/c/dev/ppb_fullscreen_dev.h56
1 files changed, 39 insertions, 17 deletions
diff --git a/ppapi/c/dev/ppb_fullscreen_dev.h b/ppapi/c/dev/ppb_fullscreen_dev.h
index b893182..d7bd528 100644
--- a/ppapi/c/dev/ppb_fullscreen_dev.h
+++ b/ppapi/c/dev/ppb_fullscreen_dev.h
@@ -1,39 +1,61 @@
-/* Copyright (c) 2010 The Chromium Authors. All rights reserved.
+/* 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.
*/
+
+/* From dev/ppb_fullscreen_dev.idl modified Fri Aug 26 10:51:16 2011. */
+
#ifndef PPAPI_C_DEV_PPB_FULLSCREEN_DEV_H_
#define PPAPI_C_DEV_PPB_FULLSCREEN_DEV_H_
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_instance.h"
+#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_size.h"
#include "ppapi/c/pp_stdint.h"
#define PPB_FULLSCREEN_DEV_INTERFACE_0_4 "PPB_Fullscreen(Dev);0.4"
#define PPB_FULLSCREEN_DEV_INTERFACE PPB_FULLSCREEN_DEV_INTERFACE_0_4
-// Use this interface to change a plugin instance to fullscreen mode.
+/**
+ * @file
+ * This file defines the <code>PPB_Fullscreen</code> interface.
+ */
+
+
+/**
+ * @addtogroup Interfaces
+ * @{
+ */
struct PPB_Fullscreen_Dev {
- // Checks whether the plugin instance is currently in fullscreen mode.
+ /**
+ * Checks whether the plugin instance is currently in fullscreen mode.
+ */
PP_Bool (*IsFullscreen)(PP_Instance instance);
-
- // Switches the plugin instance to/from fullscreen mode. Returns PP_TRUE on
- // success, PP_FALSE on failure.
- // This unbinds the current Graphics2D or Surface3D. Pending flushes and
- // swapbuffers will execute as if the resource was off-screen. The transition
- // is asynchronous. During the transition, IsFullscreen will return PP_False,
- // and no Graphics2D or Surface3D can be bound. The transition ends at the
- // next DidChangeView.
- // Note: when switching to and from fullscreen, Context3D and Surface3D
- // resources need to be re-created. This is a current limitation that will be
- // lifted in a later revision.
+ /**
+ * Switches the plugin instance to/from fullscreen mode. Returns PP_TRUE on
+ * success, PP_FALSE on failure.
+ *
+ * This unbinds the current Graphics2D or Surface3D. Pending flushes and
+ * swapbuffers will execute as if the resource was off-screen. The transition
+ * is asynchronous. During the transition, IsFullscreen will return PP_False,
+ * and no Graphics2D or Surface3D can be bound. The transition ends at the
+ * next DidChangeView.
+ *
+ * Note: when switching to and from fullscreen, Context3D and Surface3D
+ * resources need to be re-created. This is a current limitation that will be
+ * lifted in a later revision.
+ */
PP_Bool (*SetFullscreen)(PP_Instance instance, PP_Bool fullscreen);
-
- // Gets the size of the screen. When going fullscreen, the instance will be
- // resized to that size.
+ /**
+ * Gets the size of the screen. When going fullscreen, the instance will be
+ * resized to that size.
+ */
PP_Bool (*GetScreenSize)(PP_Instance instance, struct PP_Size* size);
};
+/**
+ * @}
+ */
#endif /* PPAPI_C_DEV_PPB_FULLSCREEN_DEV_H_ */