src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_fullscreen.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::Fullscreen Class Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7
   8 </div>
   9 <!--header-->
  10 <div class="contents">
  11 <!-- doxytag: class="pp::Fullscreen" -->
  12 <p><a href="classpp_1_1_fullscreen-members.html">List of all members.</a></p>
  13 <h2>
  14 Public Member Functions</h2><table class="memberdecls">
  15
  16 <tr><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;instance)</td></tr>
  17 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a4d73ff65edc8ef8f802f5a932e5081e8">~Fullscreen</a> ()</td></tr>
  18 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345">IsFullscreen</a> ()</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365">SetFullscreen</a> (bool fullscreen)</td></tr>
  20 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</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>
  21 </table>
  22 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  23 <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>
  24 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  25 <a class="anchor" id="a3c3655d21fbef531a3eec82f9eb2115b"></a><!-- doxytag: member="pp::Fullscreen::Fullscreen" ref="a3c3655d21fbef531a3eec82f9eb2115b" args="(const InstanceHandle &amp;instance)" -->
  26 <div class="memitem">
  27 <div class="memproto">
  28 <table class="memname">
  29 <tr>
  30 <td class="memname"><a class="el" href="classpp_1_1_fullscreen.html#a3c3655d21fbef531a3eec82f9eb2115b">pp::Fullscreen::Fullscreen</a> </td>
  31 <td>(</td>
  32 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  33 <td class="paramname"><em>instance</em></td><td>)</td>
  34 <td><code> [explicit]</code></td>
  35 </tr>
  36 </table>
  37 </div>
  38 <div class="memdoc">
  39 <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>
  40 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  41 <table class="params">
  42 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
  43 </table>
  44 </dd>
  45 </dl>
  46 </div>
  47 </div>
  48 <a class="anchor" id="a4d73ff65edc8ef8f802f5a932e5081e8"></a><!-- doxytag: member="pp::Fullscreen::~Fullscreen" ref="a4d73ff65edc8ef8f802f5a932e5081e8" args="()" -->
  49 <div class="memitem">
  50 <div class="memproto">
  51 <table class="memname">
  52 <tr>
  53 <td class="memname">virtual <a class="el" href="classpp_1_1_fullscreen.html#a4d73ff65edc8ef8f802f5a932e5081e8">pp::Fullscreen::~Fullscreen</a> </td>
  54 <td>(</td>
  55 <td class="paramname"></td><td>)</td>
  56 <td><code> [virtual]</code></td>
  57 </tr>
  58 </table>
  59 </div>
  60 <div class="memdoc">
  61 <p>Destructor. </p>
  62 </div>
  63 </div>
  64 <hr /><h2>Member Function Documentation</h2>
  65 <a class="anchor" id="a6bc430c1d41a7696194374d05d8eee41"></a><!-- doxytag: member="pp::Fullscreen::GetScreenSize" ref="a6bc430c1d41a7696194374d05d8eee41" args="(Size *size)" -->
  66 <div class="memitem">
  67 <div class="memproto">
  68 <table class="memname">
  69 <tr>
  70 <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a6bc430c1d41a7696194374d05d8eee41">pp::Fullscreen::GetScreenSize</a> </td>
  71 <td>(</td>
  72 <td class="paramtype"><a class="el" href="classpp_1_1_size.html">Size</a> *&#160;</td>
  73 <td class="paramname"><em>size</em></td><td>)</td>
  74 <td></td>
  75 </tr>
  76 </table>
  77 </div>
  78 <div class="memdoc">
  79 <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>
  80 <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>
  81 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  82 <table class="params">
  83 <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>The size of the entire screen in pixels.</td></tr>
  84 </table>
  85 </dd>
  86 </dl>
  87 <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> on failure. </dd></dl>
  88 </div>
  89 </div>
  90 <a class="anchor" id="a555c0d2c2fc120cfac925a62cc8a7345"></a><!-- doxytag: member="pp::Fullscreen::IsFullscreen" ref="a555c0d2c2fc120cfac925a62cc8a7345" args="()" -->
  91 <div class="memitem">
  92 <div class="memproto">
  93 <table class="memname">
  94 <tr>
  95 <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a555c0d2c2fc120cfac925a62cc8a7345">pp::Fullscreen::IsFullscreen</a> </td>
  96 <td>(</td>
  97 <td class="paramname"></td><td>)</td>
  98 <td></td>
  99 </tr>
 100 </table>
 101 </div>
 102 <div class="memdoc">
 103 <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>
 104 <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>
 105 </div>
 106 </div>
 107 <a class="anchor" id="a2c316cb6ebe4552df661aeea88e6f365"></a><!-- doxytag: member="pp::Fullscreen::SetFullscreen" ref="a2c316cb6ebe4552df661aeea88e6f365" args="(bool fullscreen)" -->
 108 <div class="memitem">
 109 <div class="memproto">
 110 <table class="memname">
 111 <tr>
 112 <td class="memname">bool <a class="el" href="classpp_1_1_fullscreen.html#a2c316cb6ebe4552df661aeea88e6f365">pp::Fullscreen::SetFullscreen</a> </td>
 113 <td>(</td>
 114 <td class="paramtype">bool&#160;</td>
 115 <td class="paramname"><em>fullscreen</em></td><td>)</td>
 116 <td></td>
 117 </tr>
 118 </table>
 119 </div>
 120 <div class="memdoc">
 121 <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>
 122 <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>
 123 <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>
 124 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 125 <table class="params">
 126 <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>
 127 </table>
 128 </dd>
 129 </dl>
 130 <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success or <code>false</code> on failure. </dd></dl>
 131 </div>
 132 </div>
 133 <hr />The documentation for this class was generated from the following file:<ul>
 134 <li><a class="el" href="fullscreen_8h.html">fullscreen.h</a></li>
 135 </ul>
 136 </div><!-- contents -->
 137 {{/partials.standard_nacl_article}}