src/native_client_sdk/doc_generated/pepper_dev/c/struct_p_p_b___instance__1__0.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_Instance 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_Instance" --><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>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___instance__1__0.html#ae5b0da2fc0975c82213f687d96434625">BindGraphics</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> device)</td></tr>
  16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___instance__1__0.html#a1a7dc39b5aa46596c91299047c6ab8b2">IsFullFrame</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td></tr>
  17 </table>
  18 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  19 <div class="textblock"><p>The PPB_Instance interface contains pointers to functions related to the module instance on a web page. </p>
  20 </div><hr /><h2>Field Documentation</h2>
  21 <a class="anchor" id="ae5b0da2fc0975c82213f687d96434625"></a><!-- doxytag: member="PPB_Instance::BindGraphics" ref="ae5b0da2fc0975c82213f687d96434625" args=")(PP_Instance instance, PP_Resource device)" -->
  22 <div class="memitem">
  23 <div class="memproto">
  24 <table class="memname">
  25 <tr>
  26 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___instance__1__0.html#ae5b0da2fc0975c82213f687d96434625">PPB_Instance::BindGraphics</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> device)</td>
  27 </tr>
  28 </table>
  29 </div>
  30 <div class="memdoc">
  31 <p><a class="el" href="struct_p_p_b___instance__1__0.html#ae5b0da2fc0975c82213f687d96434625" title="BindGraphics() binds the given graphics as the current display surface.">BindGraphics()</a> binds the given graphics as the current display surface. </p>
  32 <p>The contents of this device is what will be displayed in the instance's area on the web page. The device must be a 2D or a 3D device.</p>
  33 <p>You can pass a <code>NULL</code> resource as the device parameter to unbind all devices from the given instance. The instance will then appear transparent. Re-binding the same device will return <code>PP_TRUE</code> and will do nothing.</p>
  34 <p>Any previously-bound device will be released. It is an error to bind a device when it is already bound to another instance. If you want to move a device between instances, first unbind it from the old one, and then rebind it to the new one.</p>
  35 <p>Binding a device will invalidate that portion of the web page to flush the contents of the new device to the screen.</p>
  36 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  37 <table class="params">
  38 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A PP_Instance identifying one instance of a module. </td></tr>
  39 <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>A PP_Resource corresponding to a graphics device.</td></tr>
  40 </table>
  41 </dd>
  42 </dl>
  43 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was successful or <code>PP_FALSE</code> if the device was not the correct type. On success, a reference to the device will be held by the instance, so the caller can release its reference if it chooses. </dd></dl>
  44 </div>
  45 </div>
  46 <a class="anchor" id="a1a7dc39b5aa46596c91299047c6ab8b2"></a><!-- doxytag: member="PPB_Instance::IsFullFrame" ref="a1a7dc39b5aa46596c91299047c6ab8b2" args=")(PP_Instance instance)" -->
  47 <div class="memitem">
  48 <div class="memproto">
  49 <table class="memname">
  50 <tr>
  51 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___instance__1__0.html#a1a7dc39b5aa46596c91299047c6ab8b2">PPB_Instance::IsFullFrame</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td>
  52 </tr>
  53 </table>
  54 </div>
  55 <div class="memdoc">
  56 <p><a class="el" href="struct_p_p_b___instance__1__0.html#a1a7dc39b5aa46596c91299047c6ab8b2" title="IsFullFrame() determines if the instance is full-frame.">IsFullFrame()</a> determines if the instance is full-frame. </p>
  57 <p>Such an instance represents the entire document in a frame rather than an embedded resource. This can happen if the user does a top-level navigation or the page specifies an iframe to a resource with a MIME type registered by the module.</p>
  58 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  59 <table class="params">
  60 <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>
  61 </table>
  62 </dd>
  63 </dl>
  64 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the instance is full-frame. </dd></dl>
  65 </div>
  66 </div>
  67 <hr />The documentation for this struct was generated from the following file:<ul>
  68 <li><a class="el" href="ppb__instance_8h.html">ppb_instance.h</a></li>
  69 </ul>
  70 </div><!-- contents -->
  71 </div>
  72 {{/partials.standard_nacl_article}}