Package: cairo

Function cairo:svg-surface-create

Lambda List

cairo:svg-surface-create (path width height)

Arguments

path -- a namestring or pathname for a path for the SVG output (must be writable), nil may be used to specify no output, this will generate a SVG surface that may be queried and used as a source, without generating a temporary file
width -- a number coerced to a double float for the width of the surface, in points (1 point == 1/72.0 inch)
height -- a number coerced to a double float for the height of the surface, in points (1 point == 1/72.0 inch)

Return Value

The newly created cairo:surface-t instance. The caller owns the surface and should call the cairo:surface-destroy function when done with it. This function always returns a valid pointer, but it will return a pointer to a "nil" surface if an error such as out of memory occurs. You can use the cairo:surface-status function to check for this.

Details

Creates a SVG surface of the specified size in points to be written to path. The SVG surface backend recognizes the following MIME types for the data attached to a surface, see the cairo_surface_set_mime_data() function, when it is used as a source pattern for drawing on this surface: CAIRO_MIME_TYPE_JPEG, CAIRO_MIME_TYPE_PNG, and 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.
 

See also

2025-1-13