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