NPN_InvalidateRegion

  • Revision slug: NPN_InvalidateRegion
  • Revision title: NPN_InvalidateRegion
  • Revision id: 90625
  • Created:
  • Creator: Pmash
  • Is current revision? No
  • Comment migration

Revision Content

{{wiki.template('Np-browser-api')}}

Summary

Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in.

Syntax

#include <npapi.h>
 
void NPN_InvalidateRegion(NPP instance, 
                          NP_Region invalidRegion);

Parameters

The function has the following parameters:

instance
Pointer to the current plug-in instance.
invalidRegion
The area to invalidate, specified in a coordinate system that originates at the top left of the plug-in.

Description

Before a windowless plug-in can repaint or refresh part of its drawing area, the plug-in must first invalidate the area with either NPN_InvalidateRect or NPN_InvalidateRegion.

NPN_InvalidateRegion causes the NPP_HandleEvent method to pass an update event or a paint message to the plug-in. If a plug-in calls this method, it receives a paint message later. The browser redraws invalid areas of the document and windowless plug-ins at regularly timed intervals. To force a paint message, the plug-in can call NPN_ForceRedraw after calling this method.

See Also

NPN_ForceRedraw, NPN_InvalidateRect, NP_Region, NPP

Revision Source

<p>
{{wiki.template('Np-browser-api')}}
</p>
<h3 name="Summary">Summary</h3>
<p>Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in.
</p>
<h3 name="Syntax">Syntax</h3>
<pre>#include &lt;npapi.h&gt;
 
void NPN_InvalidateRegion(NPP instance, 
                          NP_Region invalidRegion);
</pre> 
<h3 name="Parameters">Parameters</h3>
<p>The function has the following parameters:
</p>
<dl><dt>instance
</dt><dd>Pointer to the current plug-in instance.
</dd></dl>
<dl><dt>invalidRegion
</dt><dd>The area to invalidate, specified in a coordinate system that originates at the top left of the plug-in.
</dd></dl>
<h3 name="Description">Description</h3>
<p>Before a windowless plug-in can repaint or refresh part of its drawing area, the plug-in must first invalidate the area with either <a href="en/NPN_InvalidateRect">NPN_InvalidateRect</a> or <code>NPN_InvalidateRegion</code>.
</p><p><code>NPN_InvalidateRegion</code> causes the <a href="en/NPP_HandleEvent">NPP_HandleEvent</a> method to pass an update event or a paint message to the plug-in. If a plug-in calls this method, it receives a paint message later. The browser redraws invalid areas of the document and windowless plug-ins at regularly timed intervals. To force a paint message, the plug-in can call <a href="en/NPN_ForceRedraw">NPN_ForceRedraw</a> after calling this method.
</p>
<h3 name="See_Also">See Also</h3>
<p><a href="en/NPN_ForceRedraw">NPN_ForceRedraw</a>, <a href="en/NPN_InvalidateRect">NPN_InvalidateRect</a>, <a href="en/NP_Region">NP_Region</a>, <a href="en/NPP">NPP</a>
</p>
Revert to this revision