| {{+bindTo:partials.standard_nacl_api}} |
| <h1>pp::Fullscreen Class Reference</h1> |
| <div id="doxygen-ref"> |
| {{- dummy div to appease doxygen -}} |
| <div> |
| <!-- Generated by Doxygen 1.7.6.1 --> |
| |
| |
| |
| </div> |
| <!--header--> |
| <div class="contents"> |
| <!-- doxytag: class="pp::Fullscreen" --> |
| <p><a href="classpp_1_1_fullscreen-members.html">List of all members.</a></p> |
| <h2> |
| Public Member Functions</h2><table class="memberdecls"> |
| |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a3c3655d21fbef531a3eec82f9eb2115b">Fullscreen</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &instance)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a4d73ff65edc8ef8f802f5a932e5081e8">~Fullscreen</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345">IsFullscreen</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365">SetFullscreen</a> (bool fullscreen)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a6bc430c1d41a7696194374d05d8eee41">GetScreenSize</a> (<a class="el" href="classpp_1_1_size.html">Size</a> *size)</td></tr> |
| </table> |
| <hr /><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p>The <a class="el" href="classpp_1_1_fullscreen.html" title="The Fullscreen class allowing you to check and toggle fullscreen mode.">Fullscreen</a> class allowing you to check and toggle fullscreen mode. </p> |
| </div><hr /><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a3c3655d21fbef531a3eec82f9eb2115b"></a><!-- doxytag: member="pp::Fullscreen::Fullscreen" ref="a3c3655d21fbef531a3eec82f9eb2115b" args="(const InstanceHandle &instance)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_fullscreen.html#a3c3655d21fbef531a3eec82f9eb2115b">pp::Fullscreen::Fullscreen</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> & </td> |
| <td class="paramname"><em>instance</em></td><td>)</td> |
| <td><code> [explicit]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>A constructor for creating a <code><a class="el" href="classpp_1_1_fullscreen.html" title="The Fullscreen class allowing you to check and toggle fullscreen mode.">Fullscreen</a></code>. </p> |
| <dl class="params"><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="a4d73ff65edc8ef8f802f5a932e5081e8"></a><!-- doxytag: member="pp::Fullscreen::~Fullscreen" ref="a4d73ff65edc8ef8f802f5a932e5081e8" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classpp_1_1_fullscreen.html#a4d73ff65edc8ef8f802f5a932e5081e8">pp::Fullscreen::~Fullscreen</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Destructor. </p> |
| </div> |
| </div> |
| <hr /><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a6bc430c1d41a7696194374d05d8eee41"></a><!-- doxytag: member="pp::Fullscreen::GetScreenSize" ref="a6bc430c1d41a7696194374d05d8eee41" args="(Size *size)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a6bc430c1d41a7696194374d05d8eee41">pp::Fullscreen::GetScreenSize</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpp_1_1_size.html">Size</a> * </td> |
| <td class="paramname"><em>size</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p><a class="el" href="classpp_1_1_fullscreen.html#a6bc430c1d41a7696194374d05d8eee41" title="GetScreenSize() gets the size of the screen in pixels.">GetScreenSize()</a> gets the size of the screen in pixels. </p> |
| <p>The module instance will be resized to this size when <a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365" title="SetFullscreen() switches the module instance to and from fullscreen mode.">SetFullscreen()</a> is called to enter fullscreen mode.</p> |
| <dl class="params"><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>The size of the entire screen in pixels.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> on failure. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a555c0d2c2fc120cfac925a62cc8a7345"></a><!-- doxytag: member="pp::Fullscreen::IsFullscreen" ref="a555c0d2c2fc120cfac925a62cc8a7345" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345">pp::Fullscreen::IsFullscreen</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p><a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345" title="IsFullscreen() checks whether the module instance is currently in fullscreen mode.">IsFullscreen()</a> checks whether the module instance is currently in fullscreen mode. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the module instance is in fullscreen mode, <code>false</code> if the module instance is not in fullscreen mode. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a2c316cb6ebe4552df661aeea88e6f365"></a><!-- doxytag: member="pp::Fullscreen::SetFullscreen" ref="a2c316cb6ebe4552df661aeea88e6f365" args="(bool fullscreen)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365">pp::Fullscreen::SetFullscreen</a> </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>fullscreen</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p><a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365" title="SetFullscreen() switches the module instance to and from fullscreen mode.">SetFullscreen()</a> switches the module instance to and from fullscreen mode. </p> |
| <p>The transition to and from fullscreen mode is asynchronous. During the transition, <a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345" title="IsFullscreen() checks whether the module instance is currently in fullscreen mode.">IsFullscreen()</a> will return the previous value and no 2D or 3D device can be bound. The transition ends at DidChangeView() when <a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345" title="IsFullscreen() checks whether the module instance is currently in fullscreen mode.">IsFullscreen()</a> returns the new value. You might receive other DidChangeView() calls while in transition.</p> |
| <p>The transition to fullscreen mode can only occur while the browser is processing a user gesture, even if <code>true</code> is returned.</p> |
| <dl class="params"><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">fullscreen</td><td><code>true</code> to enter fullscreen mode, or <code>false</code> to exit fullscreen mode.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> on failure. </dd></dl> |
| </div> |
| </div> |
| <hr />The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="fullscreen_8h.html">fullscreen.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div> |
| {{/partials.standard_nacl_api}} |