Name
cairo.SVGSurface -- create SVG surface
Synopsis
handle = cairo.SVGSurface(filename$, width_in_points, height_in_points)
Function
Creates a SVG surface of the specified size in points to be written to filename$.

The SVG surface backend recognizes the following MIME types for the data attached to a surface (see csurface:SetMimeData()) when it is used as a source pattern for drawing on this surface: #CAIRO_MIME_TYPE_JPEG, #CAIRO_MIME_TYPE_PNG, #CAIRO_MIME_TYPE_URI. If any of them is specified, the SVG backend emits a href with the content of MIME data instead of a surface snapshot (PNG, Base64-encoded) in the corresponding image tag.

The unofficial MIME type #CAIRO_MIME_TYPE_URI is examined first. If present, the URI is emitted as is: assuring the correctness of URI is left to the client code.

If #CAIRO_MIME_TYPE_URI is not present, but #CAIRO_MIME_TYPE_JPEG or #CAIRO_MIME_TYPE_PNG is specified, the corresponding data is Base64-encoded and emitted.

If #CAIRO_MIME_TYPE_UNIQUE_ID is present, all surfaces with the same unique identifier will only be embedded once.

This function returns a handle to the newly created surface. The caller owns the surface and should call csurface:Free() when done with it.

This function always returns a valid handle, but it will return a handle to a "nil" surface if an error such as out of memory occurs. You can use csurface:Status() to check for this.

Inputs
filename$
a filename for the SVG output (must be writable)
width_in_points
width of the surface, in points (1 point == 1/72.0 inch)
height_in_points
height of the surface, in points (1 point == 1/72.0 inch)
Results
handle
SVG surface

Show TOC