Data Fields

PP_Bool(*	IsFullscreen )(PP_Instance instance)
PP_Bool(*	SetFullscreen )(PP_Instance instance, PP_Bool fullscreen)
PP_Bool(*	GetScreenSize )(PP_Instance instance, struct PP_Size *size)

Detailed Description

The PPB_Fullscreen interface is implemented by the browser.

This interface provides a way of checking the current screen mode and toggling fullscreen mode.

Field Documentation

PP_Bool(* PPB_Fullscreen::GetScreenSize)(PP_Instance instance, struct PP_Size *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.

Parameters:

[in]	instance	A `PP_Instance` identifying one instance of a module.
[out]	size	The size of the entire screen in pixels.

Returns:: PP_TRUE on success or PP_FALSE on failure.

PP_Bool(* PPB_Fullscreen::IsFullscreen)(PP_Instance instance)

IsFullscreen() checks whether the module instance is currently in fullscreen mode.

Parameters:

[in] instance A PP_Instance identifying one instance of a module.

Returns:: PP_TRUE if the module instance is in fullscreen mode, PP_FALSE if the module instance is not in fullscreen mode.

PP_Bool(* PPB_Fullscreen::SetFullscreen)(PP_Instance instance, PP_Bool fullscreen)

SetFullscreen() switches the module instance to and from fullscreen mode.

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 mode can only occur while the browser is processing a user gesture, even if PP_TRUE is returned.

Parameters:

[in]	instance	A `PP_Instance` identifying one instance of a module.
[in]	fullscreen	`PP_TRUE` to enter fullscreen mode, or `PP_FALSE` to exit fullscreen mode.

Returns:: PP_TRUE on success or PP_FALSE on failure.

The documentation for this struct was generated from the following file:

ppb_fullscreen.h