diff options
| author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-12-21 22:00:48 +0000 |
|---|---|---|
| committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-12-21 22:00:48 +0000 |
| commit | c896ec1167490001b9b50dfdc566da7d50823928 (patch) | |
| tree | 206e2377fa54b1fbee9fc2ae8af5770dd9fd62ac /ppapi/c/ppb_fullscreen.h | |
| parent | b88961db2cf50e82abd82ab5681617409840d906 (diff) | |
| download | chromium_src-c896ec1167490001b9b50dfdc566da7d50823928.zip chromium_src-c896ec1167490001b9b50dfdc566da7d50823928.tar.gz chromium_src-c896ec1167490001b9b50dfdc566da7d50823928.tar.bz2 | |
Fixed misspelled word in ppb_image_data. Updated/rewrote docs in the other three files.
Review URL: http://codereview.chromium.org/8524001
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@115416 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c/ppb_fullscreen.h')
| -rw-r--r-- | ppapi/c/ppb_fullscreen.h | 57 |
1 files changed, 43 insertions, 14 deletions
diff --git a/ppapi/c/ppb_fullscreen.h b/ppapi/c/ppb_fullscreen.h index 18d52ba..72ff98d 100644 --- a/ppapi/c/ppb_fullscreen.h +++ b/ppapi/c/ppb_fullscreen.h @@ -3,7 +3,7 @@ * found in the LICENSE file. */ -/* From ppb_fullscreen.idl modified Sun Oct 16 22:32:54 2011. */ +/* From ppb_fullscreen.idl modified Wed Dec 21 11:00:23 2011. */ #ifndef PPAPI_C_PPB_FULLSCREEN_H_ #define PPAPI_C_PPB_FULLSCREEN_H_ @@ -19,7 +19,8 @@ /** * @file - * This file defines the <code>PPB_Fullscreen</code> interface. + * This file defines the <code>PPB_Fullscreen</code> interface for + * handling transitions of a module instance to and from fullscreen mode. */ @@ -27,28 +28,56 @@ * @addtogroup Interfaces * @{ */ +/** + * The <code>PPB_Fullscreen</code> interface is implemented by the browser. + * This interface provides a way of checking the current screen mode and + * toggling fullscreen mode. + */ struct PPB_Fullscreen { /** - * Checks whether the plugin instance is currently in fullscreen mode. + * IsFullscreen() checks whether the module instance is currently in + * fullscreen mode. + * + * @param[in] instance A <code>PP_Instance</code> identifying one instance + * of a module. + * + * @return <code>PP_TRUE</code> if the module instance is in fullscreen mode, + * <code>PP_FALSE</code> if the module instance is not 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. + * SetFullscreen() switches the module instance to and from fullscreen + * mode. * - * The transition to and from fullscreen is asynchronous. - * During the transition, IsFullscreen will return the original value, and - * no 2D or 3D device can be bound. The transition ends at DidChangeView - * when IsFullscreen returns the new value. You might receive other - * DidChangeView calls while in transition. + * The transition to and from fullscreen mode is asynchronous. During the + * transition, IsFullscreen() will return the previous value and + * no 2D or 3D device can be bound. The transition ends at DidChangeView() + * when IsFullscreen() returns the new value. You might receive other + * DidChangeView() calls while in transition. * - * The transition to fullscreen can only occur while the browser is - * processing a user gesture, even if PP_TRUE is returned. + * The transition to fullscreen mode can only occur while the browser is + * processing a user gesture, even if <code>PP_TRUE</code> is returned. + * + * @param[in] instance A <code>PP_Instance</code> identifying one instance + * of a module. + * @param[in] fullscreen <code>PP_TRUE</code> to enter fullscreen mode, or + * <code>PP_FALSE</code> to exit fullscreen mode. + * + * @return <code>PP_TRUE</code> on success or <code>PP_FALSE</code> on + * failure. */ PP_Bool (*SetFullscreen)(PP_Instance instance, PP_Bool fullscreen); /** - * Gets the size of the screen in pixels. When going fullscreen, the instance - * will be resized to that size. + * GetScreenSize() gets the size of the screen in pixels. The module instance + * will be resized to this size when SetFullscreen() is called to enter + * fullscreen mode. + * + * @param[in] instance A <code>PP_Instance</code> identifying one instance + * of a module. + * @param[out] size The size of the entire screen in pixels. + * + * @return <code>PP_TRUE</code> on success or <code>PP_FALSE</code> on + * failure. */ PP_Bool (*GetScreenSize)(PP_Instance instance, struct PP_Size* size); }; |