1 {{+bindTo:partials.standard_nacl_api}} 2 <h1>PPB_Fullscreen Struct 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 </div> 10 <!--header--> 11 <div class="contents"> 12 <!-- doxytag: class="PPB_Fullscreen" --><h2> 13 Data Fields</h2><table class="memberdecls"> 14 15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___fullscreen__1__0.html#a8b6a560d3a57b6df9395b5dcf138cd1d">IsFullscreen</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td></tr> 16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___fullscreen__1__0.html#a1074f98a5800667313de626b0ed8ad27">SetFullscreen</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a> fullscreen)</td></tr> 17 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___fullscreen__1__0.html#afc4e416a40c4bf0ed1dd0cae74547c86">GetScreenSize</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, struct <a class="el" href="struct_p_p___size.html">PP_Size</a> *size)</td></tr> 18 </table> 19 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2> 20 <div class="textblock"><p>The <code>PPB_Fullscreen</code> interface is implemented by the browser. </p> 21 <p>This interface provides a way of checking the current screen mode and toggling fullscreen mode. </p> 22 </div><hr /><h2>Field Documentation</h2> 23 <a class="anchor" id="afc4e416a40c4bf0ed1dd0cae74547c86"></a><!-- doxytag: member="PPB_Fullscreen::GetScreenSize" ref="afc4e416a40c4bf0ed1dd0cae74547c86" args=")(PP_Instance instance, struct PP_Size *size)" --> 24 <div class="memitem"> 25 <div class="memproto"> 26 <table class="memname"> 27 <tr> 28 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___fullscreen__1__0.html#afc4e416a40c4bf0ed1dd0cae74547c86">PPB_Fullscreen::GetScreenSize</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, struct <a class="el" href="struct_p_p___size.html">PP_Size</a> *size)</td> 29 </tr> 30 </table> 31 </div> 32 <div class="memdoc"> 33 <p><a class="el" href="struct_p_p_b___fullscreen__1__0.html#afc4e416a40c4bf0ed1dd0cae74547c86" title="GetScreenSize() gets the size of the screen in pixels.">GetScreenSize()</a> gets the size of the screen in pixels. </p> 34 <p>The module instance will be resized to this size when <a class="el" href="struct_p_p_b___fullscreen__1__0.html#a1074f98a5800667313de626b0ed8ad27" title="SetFullscreen() switches the module instance to and from fullscreen mode.">SetFullscreen()</a> is called to enter fullscreen mode.</p> 35 <dl class="params"><dt><b>Parameters:</b></dt><dd> 36 <table class="params"> 37 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying one instance of a module. </td></tr> 38 <tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>The size of the entire screen in pixels.</td></tr> 39 </table> 40 </dd> 41 </dl> 42 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> on success or <code>PP_FALSE</code> on failure. </dd></dl> 43 </div> 44 </div> 45 <a class="anchor" id="a8b6a560d3a57b6df9395b5dcf138cd1d"></a><!-- doxytag: member="PPB_Fullscreen::IsFullscreen" ref="a8b6a560d3a57b6df9395b5dcf138cd1d" args=")(PP_Instance instance)" --> 46 <div class="memitem"> 47 <div class="memproto"> 48 <table class="memname"> 49 <tr> 50 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___fullscreen__1__0.html#a8b6a560d3a57b6df9395b5dcf138cd1d">PPB_Fullscreen::IsFullscreen</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td> 51 </tr> 52 </table> 53 </div> 54 <div class="memdoc"> 55 <p><a class="el" href="struct_p_p_b___fullscreen__1__0.html#a8b6a560d3a57b6df9395b5dcf138cd1d" 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> 56 <dl class="params"><dt><b>Parameters:</b></dt><dd> 57 <table class="params"> 58 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying one instance of a module.</td></tr> 59 </table> 60 </dd> 61 </dl> 62 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the module instance is in fullscreen mode, <code>PP_FALSE</code> if the module instance is not in fullscreen mode. </dd></dl> 63 </div> 64 </div> 65 <a class="anchor" id="a1074f98a5800667313de626b0ed8ad27"></a><!-- doxytag: member="PPB_Fullscreen::SetFullscreen" ref="a1074f98a5800667313de626b0ed8ad27" args=")(PP_Instance instance, PP_Bool fullscreen)" --> 66 <div class="memitem"> 67 <div class="memproto"> 68 <table class="memname"> 69 <tr> 70 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___fullscreen__1__0.html#a1074f98a5800667313de626b0ed8ad27">PPB_Fullscreen::SetFullscreen</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a> fullscreen)</td> 71 </tr> 72 </table> 73 </div> 74 <div class="memdoc"> 75 <p><a class="el" href="struct_p_p_b___fullscreen__1__0.html#a1074f98a5800667313de626b0ed8ad27" title="SetFullscreen() switches the module instance to and from fullscreen mode.">SetFullscreen()</a> switches the module instance to and from fullscreen mode. </p> 76 <p>The transition to and from fullscreen mode is asynchronous. During the transition, <a class="el" href="struct_p_p_b___fullscreen__1__0.html#a8b6a560d3a57b6df9395b5dcf138cd1d" 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="struct_p_p_b___fullscreen__1__0.html#a8b6a560d3a57b6df9395b5dcf138cd1d" 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> 77 <p>The transition to fullscreen mode can only occur while the browser is processing a user gesture, even if <code>PP_TRUE</code> is returned.</p> 78 <dl class="params"><dt><b>Parameters:</b></dt><dd> 79 <table class="params"> 80 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying one instance of a module. </td></tr> 81 <tr><td class="paramdir">[in]</td><td class="paramname">fullscreen</td><td><code>PP_TRUE</code> to enter fullscreen mode, or <code>PP_FALSE</code> to exit fullscreen mode.</td></tr> 82 </table> 83 </dd> 84 </dl> 85 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> on success or <code>PP_FALSE</code> on failure. </dd></dl> 86 </div> 87 </div> 88 <hr />The documentation for this struct was generated from the following file:<ul> 89 <li><a class="el" href="ppb__fullscreen_8h.html">ppb_fullscreen.h</a></li> 90 </ul> 91 </div><!-- contents --> 92 </div> 93 {{/partials.standard_nacl_api}} 94