README
¶
oksvg
oksvg is a rasterizer for a partial implementation of the SVG2.0 specification in golang.
Although many SVG elements will not be read by oksvg, it is good enough to faithfully produce thousands, but certainly not all, SVG icons available both for free and commercially. A list of valid and invalid elements is in the doc folder.
oksvg uses the rasterx rasterizer package which implements full SVG2.0 path functions, including the newer 'arc' join-mode.
Extra non-standard features.
In addition to 'arc' as a valid join mode value, oksvg also allows 'arc-clip' which is the arc analog of miter-clip and some extra capping and gap values. It can also specify different capping functions for line starts and ends.
Rasterizations of SVG to PNG from creative commons 3.0 sources.
Example renderings of unedited open source SVG files by oksvg and rasterx are shown below.
Thanks to Freepik from Flaticon Licensed by Creative Commons 3.0 for the example icons shown below, and also used as test icons in the testdata folder.
Non-standard library dependencies
oksvg requires the following imports which are not included in the go standard library:
- golang.org/x/net/html/charset
- golang.org/x/image/colornames
- golang.org/x/image/math/fixed
These can be included in your gopath by the following 'get' commands:
- "go get golang.org/x/image/math/fixed"
- "go get golang.org/x/image/colornames"
- "go get golang.org/x/net/html/charset"
oksvg also requires the user to get or clone into the workspace the rasterx package located here:
- github.com/srwiley/rasterx
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultStyle = PathStyle{1.0, 1.0, 2.0, 0.0, 4.0, nil, true, color.NRGBA{0x00, 0x00, 0x00, 0xff}, nil, nil, nil, rasterx.ButtCap, rasterx.Bevel, rasterx.MatrixAdder{M: rasterx.Identity}}
DefaultStyle sets the default PathStyle to fill black, winding rule, full opacity, no stroke, ButtCap line end and Bevel line connect.
Functions ¶
func ParseSVGColor ¶
ParseSVGColor parses an SVG color string in all forms including all SVG1.1 names, obtained from the colornames package
func ParseSVGColorNum ¶
ParseSVGColorNum reads the SFG color string e.g. #FBD9BD
Types ¶
type ErrorMode ¶
type ErrorMode uint8
ErrorMode is the for setting how the parser reacts to unparsed elements
type IconCursor ¶
type IconCursor struct {
PathCursor
StyleStack []PathStyle
// contains filtered or unexported fields
}
IconCursor is used while parsing SVG files
func (*IconCursor) PushStyle ¶
func (c *IconCursor) PushStyle(attrs []xml.Attr) error
PushStyle parses the style element, and push it on the style stack. Only color and opacity are supported for fill. Note that this parses both the contents of a style attribute plus direct fill and opacity attributes.
func (*IconCursor) ReadGradAttr ¶
func (c *IconCursor) ReadGradAttr(attr xml.Attr) (err error)
ReadGradAttr reads an SVG gradient attribute
func (*IconCursor) ReadGradURL ¶
func (c *IconCursor) ReadGradURL(v string) (grad *rasterx.Gradient, err error)
ReadGradURL reads an SVG format gradient url
type PathCursor ¶
type PathCursor struct {
rasterx.Path
ErrorMode ErrorMode
// contains filtered or unexported fields
}
PathCursor is used to parse SVG format path strings into a rasterx Path
func (*PathCursor) AddArcFromA ¶
func (c *PathCursor) AddArcFromA(points []float64)
AddArcFromA adds a path of an arc element to the cursor path to the PathCursor
func (*PathCursor) CompilePath ¶
func (c *PathCursor) CompilePath(svgPath string) error
CompilePath translates the svgPath description string into a rasterx path. All valid SVG path elements are interpreted to rasterx equivalents. The resulting path element is stored in the PathCursor.
func (*PathCursor) EllipseAt ¶
func (c *PathCursor) EllipseAt(cx, cy, rx, ry float64)
EllipseAt adds a path of an elipse centered at cx, cy of radius rx and ry to the PathCursor
func (*PathCursor) GetPoints ¶
func (c *PathCursor) GetPoints(dataPoints string) error
GetPoints reads a set of floating point values from the SVG format number string, and add them to the cursor's points slice.
func (*PathCursor) ReadFloat ¶
func (c *PathCursor) ReadFloat(numStr string) error
ReadFloat reads a floating point value and adds it to the cursor's points slice.
type PathStyle ¶
type PathStyle struct {
FillOpacity, LineOpacity float64
LineWidth, DashOffset, MiterLimit float64
Dash []float64
UseNonZeroWinding bool
LineGap rasterx.GapFunc
LeadLineCap rasterx.CapFunc // This is used if different than LineCap
LineCap rasterx.CapFunc
LineJoin rasterx.JoinMode
// contains filtered or unexported fields
}
PathStyle holds the state of the SVG style
type SvgIcon ¶
type SvgIcon struct {
ViewBox struct{ X, Y, W, H float64 }
Titles []string // Title elements collect here
Descriptions []string // Description elements collect here
Grads map[string]*rasterx.Gradient
Defs map[string][]definition
SVGPaths []SvgPath
Transform rasterx.Matrix2D
}
SvgIcon holds data from parsed SVGs
func ReadIcon ¶
ReadIcon reads the Icon from the named file This only supports a sub-set of SVG, but is enough to draw many icons. If errMode is provided, the first value determines if the icon ignores, errors out, or logs a warning if it does not handle an element found in the icon file. Ignore warnings is the default if no ErrorMode value is provided.
func ReadIconStream ¶
ReadIconStream reads the Icon from the given io.Reader This only supports a sub-set of SVG, but is enough to draw many icons. If errMode is provided, the first value determines if the icon ignores, errors out, or logs a warning if it does not handle an element found in the icon file. Ignore warnings is the default if no ErrorMode value is provided.
Source Files