nsISVGRendererCanvas Interface Reference
[Rendering Engine Interfaces]

import "nsISVGRendererCanvas.idl";

Inheritance diagram for nsISVGRendererCanvas:

[legend]List of all members.

---

Detailed Description

One of a number of interfaces (all starting with nsISVGRenderer*) to be implemented by an SVG rendering engine. See nsISVGRenderer for more details.

This interface abstracts a rendering engine-native canvas object onto which path and glyph geometries can be painted.

A canvas object is instantiated by the backend for a given Mozilla-native rendering object with a call to nsISVGRenderer::createCanvas().

Definition at line 71 of file nsISVGRendererCanvas.idl.

Public Member Functions

• nsIRenderingContext lockRenderingContext ([const] in nsRectRef rect)
• void unlockRenderingContext ()
• nsIPresContext getPresContext ()
• void clear (in nscolor color)
• void flush ()

---

Member Function Documentation

nsIRenderingContext nsISVGRendererCanvas::lockRenderingContext (  [const] in nsRectRef  rect  )

Lock a portion of the canvas and obtain a rendering context onto which Mozilla can paint non-svg content. This is needed for (partial) foreignObject support. lockRenderingContext() calls are paired with unlockRenderingContext() calls. Parameters: rect  Area to be locked. Returns: Mozilla-native rendering context for the locked area.

void nsISVGRendererCanvas::unlockRenderingContext (   )

Unlock the canvas portion locked with a previous call to lockRenderingContext().

nsIPresContext nsISVGRendererCanvas::getPresContext (   )

void nsISVGRendererCanvas::clear (  in nscolor  color  )

Fill the canvas with the given color. Parameters: color  Fill color.

void nsISVGRendererCanvas::flush (   )

Ensure that all renderings on the canvas have been flushed to the Mozilla-native rendering context.

---

The documentation for this interface was generated from the following file:

• /layout/svg/renderer/public/nsISVGRendererCanvas.idl

---