Public Member Functions

	Fullscreen (const InstanceHandle &instance)
virtual	~Fullscreen ()
bool	IsFullscreen ()
bool	SetFullscreen (bool fullscreen)
bool	GetScreenSize (Size *size)

Detailed Description

The Fullscreen class allowing you to check and toggle fullscreen mode.

Constructor & Destructor Documentation

pp::Fullscreen::Fullscreen ( const InstanceHandle & instance ) [explicit]

A constructor for creating a Fullscreen.

Parameters:

[in] instance The instance with which this resource will be associated.

virtual pp::Fullscreen::~Fullscreen ( ) [virtual]

Destructor.

Member Function Documentation

bool pp::Fullscreen::GetScreenSize ( 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:

[out] size The size of the entire screen in pixels.

Returns:: true on success or false on failure.

bool pp::Fullscreen::IsFullscreen ( )

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

Returns:: true if the module instance is in fullscreen mode, false if the module instance is not in fullscreen mode.

bool pp::Fullscreen::SetFullscreen ( 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 true is returned.

Parameters:

[in] fullscreen true to enter fullscreen mode, or false to exit fullscreen mode.

Returns:: true on success or false on failure.

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

fullscreen.h