Crate usvg

source ·
Expand description

usvg (micro SVG) is an SVG simplification tool.

Purpose

Imagine, that you have to extract some data from the SVG file, but your library/framework/language doesn’t have a good SVG library. And all you need is paths data.

You can try to export it by yourself (how hard can it be, right). All you need is an XML library (I’ll hope that your language has one). But soon you realize that paths data has a pretty complex format and a lot of edge-cases. And we didn’t mention attributes propagation, transforms, visibility flags, attribute values validation, XML quirks, etc. It will take a lot of time and code to implement this stuff correctly.

So, instead of creating a library that can be used from any language (impossible), usvg takes a different approach. It converts an input SVG to an extremely simple representation, which is still a valid SVG. And now, all you need is to convert your SVG to a simplified one via usvg and an XML library with some small amount of code.

Key features of the simplified SVG

  • No basic shapes (rect, circle, etc). Only paths
  • Simple paths:
    • Only MoveTo, LineTo, CurveTo and ClosePath will be produced
    • All path segments are in absolute coordinates
    • No implicit segment commands
    • All values are separated by space
  • All (supported) attributes are resolved. No implicit one
  • No use. Everything is resolved
  • No invisible elements
  • No invalid elements (like rect with negative/zero size)
  • No units (mm, em, etc.)
  • No comments
  • No DTD
  • No CSS (partial support)
  • No script (simply ignoring it)

Full spec can be found here.

Limitations

  • Currently, it’s not lossless. Some SVG features isn’t supported yet and will be ignored.
  • CSS support is minimal.
  • Scripting and animation isn’t supported and not planned.
  • a elements will be removed.
  • Unsupported elements:
    • some filter-based elements
    • font-based elements
    • marker

Re-exports

pub extern crate lyon_geom;
pub extern crate svgdom;

Modules

Basic traits for tree manipulations.
Some useful utilities.

Macros

Task, return value.
Task, return value, warning message.

Structs

Representation of the preserveAspectRatio attribute.
A generic gradient.
A clip-path element.
Representation of the <color> type.
A blend filter primitive.
A composite filter primitive.
A flood filter primitive.
A Gaussian blur filter primitive.
An image filter primitive.
A merge filter primitive.
An offset filter primitive.
A tile filter primitive.
A fill style.
A filter element.
A filter primitive element.
A font description.
A font-size value.
A group container.
A raster image element.
Line representation.
A linear gradient.
A marker element.
A mask element.
Representation of the <list-of-numbers> type.
An opacity value.
Processing options.
A path element.
A path marker properties.
A pattern element.
A 2D point representation.
A positive number.
A radial gradient.
A rect representation.
A 2D size representation.
Gradient’s stop element.
A stroke style.
A stroke-miterlimit value.
A stroke-width value.
An SVG root element.
A text element.
A text chunk.
A text decoration.
A text decoration style.
A text span.
Representation of the <transform> type.
A nodes tree container.
View box.

Enums

Representation of the align value of the preserveAspectRatio attribute.
A baseline shift value.
A color interpolation mode.
List of all errors.
An images blending mode.
An images compositing operation.
Kind of the feImage data.
A fill rule.
Identifies input for a filter primitive.
A filter kind.
A font stretch.
A font style.
A font variant.
A font weight.
A raster image container.
An image codec.
A line cap.
A line join.
A marker orientation.
A marker units.
Node’s kind.
An overflow property.
A paint style.
A path absolute segment.
A spread method.
A text anchor.
An element units.
A visibility property.

Traits

A trait for fuzzy/approximate equality comparisons of float numbers.
A trait for fuzzy/approximate comparisons of float numbers.
Additional Node methods.

Functions

Bounds f64 number.
Loads SVG, SVGZ file content.

Type Definitions

Alias for rctree::Node<NodeKind>.
An alias to Opacity.