Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wieslawsoltes/Svg.Skia

An SVG rendering library.
https://github.com/wieslawsoltes/Svg.Skia

2d avalonia avaloniaui geometry graphics rendering shapes skia skiasharp svg vector vector-graphics

Last synced: 3 months ago
JSON representation

An SVG rendering library.

Awesome Lists containing this project

README 

        
# Svg.Skia



[![Gitter](https://badges.gitter.im/wieslawsoltes/Svg.Skia.svg)](https://gitter.im/wieslawsoltes/Svg.Skia?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)



[![Build Status](https://dev.azure.com/wieslawsoltes/GitHub/_apis/build/status/wieslawsoltes.Svg.Skia?branchName=master)](https://dev.azure.com/wieslawsoltes/GitHub/_build/latest?definitionId=93&branchName=master)

![CI](https://github.com/wieslawsoltes/Svg.Skia/workflows/CI/badge.svg)



[![NuGet](https://img.shields.io/nuget/v/svg.skia.svg)](https://www.nuget.org/packages/svg.skia)

[![NuGet](https://img.shields.io/nuget/dt/svg.skia.svg)](https://www.nuget.org/packages/svg.skia)

[![MyGet](https://img.shields.io/myget/svgskia-nightly/vpre/svg.skia.svg?label=myget)](https://www.myget.org/gallery/svgskia-nightly)



[![GitHub release](https://img.shields.io/github/release/wieslawsoltes/svg.skia.svg)](https://github.com/wieslawsoltes/svg.skia)

[![Github All Releases](https://img.shields.io/github/downloads/wieslawsoltes/svg.skia/total.svg)](https://github.com/wieslawsoltes/svg.skia)

[![Github Releases](https://img.shields.io/github/downloads/wieslawsoltes/svg.skia/latest/total.svg)](https://github.com/wieslawsoltes/svg.skia)



*Svg.Skia* is an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) rendering library.



## About



*Svg.Skia* can be used as a .NET library or as a CLI application

to render SVG files based on a [static](http://www.w3.org/TR/SVG11/feature#SVG-static)

[SVG Full 1.1](https://www.w3.org/TR/SVG11/) subset to raster images or

to a backend's canvas.



The `Svg.Skia` is using [SVG](https://github.com/vvvv/SVG) library to load `Svg` object model. 



The `Svg.Skia` library is implemented using the `SkiaSharp` rendering backend that aims to be on par 

or more complete than the original `System.Drawing` implementation and more performant and cross-platform.



The `Svg.Skia` can be used in same way as the [SkiaSharp.Extended.Svg](https://github.com/mono/SkiaSharp.Extended/tree/main/source/SkiaSharp.Extended.Svg) 

(load `svg` files as `SKPicture`). 



The `Svg` library has a more complete implementation of the `Svg` document model than [SkiaSharp.Extended.Svg](https://github.com/mono/SkiaSharp.Extended/tree/main/source/SkiaSharp.Extended.Svg)

and the `Svg.Skia` renderer will provide more complete rendering subsystem implementation.



## NuGet



Svg.Skia is delivered as a NuGet package.



You can find the packages here [NuGet](https://www.nuget.org/packages/Svg.Skia/) and install the package like this:



`Install-Package Svg.Skia`



or by using nightly build feed:

* Add `https://www.myget.org/F/svgskia-nightly/api/v2` to your package sources

* Alternative nightly build feed `https://pkgs.dev.azure.com/wieslawsoltes/GitHub/_packaging/Nightly/nuget/v3/index.json`

* Update your package using `Svg.Skia` feed



and install the package like this:



`Install-Package Svg.Skia -Pre`



## Usage



### Library



#### Install Package



```

dotnet add package Svg.Skia

```



```

Install-Package Svg.Skia

```



#### Draw on Canvas



```C#

using SkiaSharp;

using Svg.Skia;



var svg = new SKSvg();



svg.Load("image.svg");



SKCanvas canvas = ...

canvas.DrawPicture(svg.Picture);

```



#### Save as Png



```C#

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svg") is { })

    {

        svg.Save("image.png", SKEncodedImageFormat.Png, 100, 1f, 1f);

    }

}

```



```C#

using System.IO;

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svg") is { })

    {

        using (var stream = File.OpenWrite("image.png"))

        {

            svg.Picture.ToImage(stream, SKColors.Empty, SKEncodedImageFormat.Png, 100, 1f, 1f);

        }

    }

}

```



```C#

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svgz") is { })

    {

        svg.Save("image.png", SKEncodedImageFormat.Png, 100, 1f, 1f);

    }

}

```



```C#

using System.IO;

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svgz") is { })

    {

        using (var stream = File.OpenWrite("image.png"))

        {

            svg.Picture.ToImage(stream, SKColors.Empty, SKEncodedImageFormat.Png, 100, 1f, 1f);

        }

    }

}

```



#### Save as Pdf



```C#

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svg") is { })

    {

        svg.Picture.ToPdf("image.pdf", SKColors.Empty, 1f, 1f);

    }

}

```



#### Save as Xps



```C#

using SkiaSharp;

using Svg.Skia;



using (var svg = new SKSvg())

{

    if (svg.Load("image.svg") is { })

    {

        svg.Picture.ToXps("image.xps", SKColors.Empty, 1f, 1f);

    }

}

```



### AvaloniaUI



#### Install Package



```

dotnet add package Avalonia.Svg.Skia

```



```

Install-Package Avalonia.Svg.Skia

```



### Svg control



```XAML



```



#### Image control



```XAML



```



### CSS styling



```XAML



```



```XAML



  <Setter Property="(Svg.Css)" Value=".Black { fill: #FF0000; }" />



```



```XAML



```



```XAML



  

    

  



```



```XAML



  

    

  



```



#### Avalonia Previewer



To make controls work with `Avalonia Previewer` please add the following lines to `BuildAvaloniaApp()` method:

```C#

GC.KeepAlive(typeof(SvgImageExtension).Assembly);

GC.KeepAlive(typeof(Avalonia.Svg.Skia.Svg).Assembly);

```



The `BuildAvaloniaApp()` should look similar to this:

```C#

public static AppBuilder BuildAvaloniaApp()

{

    GC.KeepAlive(typeof(SvgImageExtension).Assembly);

    GC.KeepAlive(typeof(Avalonia.Svg.Skia.Svg).Assembly);

    return AppBuilder.Configure()

        .UsePlatformDetect()

        .LogToTrace();

}

```



This is know issue as previewer not always loads all dependencies, especially custom controls in Avalonia xmlns, other solution would be to add xmlns prefix to control with provided assembly path.



### AvaloniaUI SkiaSharp Controls



#### Install Package



```

dotnet add package Avalonia.Controls.Skia

```



```

Install-Package Avalonia.Controls.Skia

```



#### Canvas



Usage:

```xaml



```



```C#

CanvasControl.Draw += (_, e) =>

{

    e.Canvas.DrawRect(SKRect.Create(0f, 0f, 100f, 100f), new SKPaint { Color = SKColors.Aqua });

};

```



### Command-line tool



```

dotnet tool install -g Svg.Skia.Converter

```



```

Svg.Skia.Converter:

  Converts a svg file to an encoded bitmap image.



Usage:

  Svg.Skia.Converter [options]



Options:

  -f, --inputFiles               The relative or absolute path to the input files

  -d, --inputDirectory       The relative or absolute path to the input directory

  -o, --outputDirectory     The relative or absolute path to the output directory

  --outputFiles                 The relative or absolute path to the output files

  -p, --pattern                     The search string to match against the names of files in the input directory

  --format                           The output image format

  -q, --quality                     The output image quality

  -b, --background               The output image background

  -s, --scale                         The output image horizontal and vertical scaling factor

  --scaleX, -sx                      The output image horizontal scaling factor

  --scaleY, -sy                      The output image vertical scaling factor

  --systemLanguage           The system language name as defined in BCP 47

  --quiet                                    Set verbosity level to quiet

  -c, --load-config             The relative or absolute path to the config file

  --save-config                 The relative or absolute path to the config file

  --version                                  Show version information

  -?, -h, --help                             Show help and usage information

```



Supported formats: png, jpg, jpeg, webp, pdf, xps



## SVG to C# Compiler



### About



SVGC compiles SVG drawing markup to C# using SkiaSharp as rendering engine. SVGC can be also used as codegen for upcoming C# 9 Source Generator feature.



[![Demo](images/Demo.png)](images/Demo.png)



### Source Generator Usage



Add NuGet package reference to your `csproj`.



```xml



  Exe

  net6.0

  latest



```



```xml



  



```



Include `svg` assets file in your `csproj`.



```xml



  



```



Use generated `SKPicture` using static `Picture` property from `Sample` class.



```C#

using SkiaSharp;

using Assets;



public void Draw(SKCanvas canvas)

{

    canvas.DrawPicture(Sample.Picture);

}

```



### Avalonia Usage



`csproj`

```xml



  



```

```xml



  

  



```



`xaml`

```xaml



    

        

    

    

        

    



```



### svgc Usage



```

svgc:

  Converts a svg file to a C# code.



Usage:

  svgc [options]



Options:

  -i, --inputFile       The relative or absolute path to the input file [default: ]

  -o, --outputFile     The relative or absolute path to the output file [default: ]

  -j, --jsonFile         The relative or absolute path to the json file [default: ]

  -n, --namespace       The generated C# namespace name [default: Svg]

  -c, --class               The generated C# class name [default: Generated]

  --version                        Show version information

  -?, -h, --help                   Show help and usage information

```



Json File Format

```json

[

    { "InputFile":"file1.svg", "OutputFile":"file1.svg.cs", "Class":"ClassName1", "Namespace":"NamespaceName" },

    { "InputFile":"file2.svg", "OutputFile":"file2.svg.cs", "Class":"ClassName2", "Namespace":"NamespaceName" }

]

```



### Links



* [Source Generators Cookbook](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.cookbook.md)

* [Source Generators](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.md)

* [Source Generators Samples](https://github.com/dotnet/roslyn-sdk/tree/master/samples/CSharp/SourceGenerators)

* [Introducing C# Source Generators](https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/)



## Build



To build the projects you need to install [.NET 5.0](https://dotnet.microsoft.com/download/dotnet/5.0) version `SDK 5.0.100`.



```

git clone [email protected]:wieslawsoltes/Svg.Skia.git

cd Svg.Skia

git submodule update --init --recursive

dotnet build -c Release

```



### Publish Managed



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r win7-x64 /p:PublishTrimmed=True /p:PublishReadyToRun=True -o Svg.Skia.Converter_net6.0_win7-x64

```



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r ubuntu.14.04-x64 /p:PublishTrimmed=True /p:PublishReadyToRun=True -o Svg.Skia.Converter_net6.0_ubuntu.14.04-x64

```



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r osx.10.12-x64 /p:PublishTrimmed=True /p:PublishReadyToRun=True -o Svg.Skia.Converter_net6.0_osx.10.12-x64

```



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r debian.8-x64 /p:PublishTrimmed=True /p:PublishReadyToRun=True -o Svg.Skia.Converter_net6.0_debian.8-x64

```



```

cd ./src/SvgToPng

dotnet publish -c Release -f net6.0 -r win7-x64 -o SvgToPng_net6.0_win7-x64

```



```

cd ./src/SvgXml.Diagnostics

dotnet publish -c Release -f net6.0 -r win7-x64 -o SvgXml.Diagnostics_net6.0_win7-x64

```



### Publish Native



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r win-x64 -o Svg.Skia.Converter_net6.0_win-x64

```



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r linux-x64 -o Svg.Skia.Converter_net6.0_linux-x64

```



```

cd ./src/Svg.Skia.Converter

dotnet publish -c Release -f net6.0 -r osx-x64 -o Svg.Skia.Converter_net6.0_osx-x64

```



## Externals



The `Svg.Skia` library is using code from the https://github.com/vvvv/SVG



## License



Parts of Svg.Skia source code are adapted from the https://github.com/vvvv/SVG



Svg.Skia is licensed under the [MIT license](LICENSE.TXT).