README.md

   1 [![License](https://img.shields.io/badge/licence-MIT-green.svg?style=flat)](LICENSE)
   2 [![Gitter](https://badges.gitter.im/thorvg/community.svg)](https://gitter.im/thorvg/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
   3 <br>
   4 [![Build Linux](https://github.com/Samsung/thorvg/actions/workflows/actions.yml/badge.svg?branch=master&event=push)](https://github.com/Samsung/thorvg/actions/workflows/actions.yml)
   5 [![Build Windows](https://github.com/Samsung/thorvg/actions/workflows/build_win.yml/badge.svg?branch=master&event=push)](https://github.com/Samsung/thorvg/actions/workflows/build_win.yml)
   6
   7 # ThorVG
   8
   9 <p align="center">
  10   <img width="500" height="346" src="https://github.com/Samsung/thorvg/blob/master/res/thorvg_card2.png">
  11 </p>
  12
  13 ThorVG is a platform-independent portable library for drawing vector-based scenes and animation. It's open-source software that is freely used by a variety of software platforms and applications. ThorVG provides neat and easy APIs. Its library has no dependencies and keeps a super compact size. It serves as the vector graphics engine for Tizen OS that powers many products. <br />
  14 <br />
  15 The following list shows primitives that are supported by ThorVG: <br />
  16  - Shapes: Line, Arc, Curve, Path, Polygon, ...
  17  - Filling: Solid, Linear and Radial Gradient
  18  - Scene Graph & Affine Transformation (translation, rotation, scale, ...)
  19  - Stroking: Width, Join, Cap, Dash
  20  - Composition: Blending, Masking, Path Clipping, ...
  21  - Pictures: TVG, SVG, JPG, PNG, Bitmap
  22 <p align="center">
  23   <img width="930" height="473" src="https://github.com/Samsung/thorvg/blob/master/res/example_primitives.png">
  24 </p>
  25 <br />
  26 If your program has the main renderer, your program could call ThorVG APIs while switching drawing contexts between the main renderer and ThorVG. During the API calls, ThorVG serializes drawing commands among the volatile paints' nodes then performs synchronous/asynchronous rendering using its backend raster engines. ThorVG supports vector images such as SVG, also expands, supporting other popular formats on demand. On the rendering, it could spawn intermediate frame-buffers for compositing scenes only when it's necessary. The next figure shows you a brief strategy on how to use ThorVG on your system.<br />
  27 <br />
  28 <p align="center">
  29   <img width="900" height="288" src="https://github.com/Samsung/thorvg/blob/master/res/example_flow.png">
  30 </p>
  31 <br />
  32 ThorVG has the threading mechanism so that it tries to acquire the next scenes without delay. It runs its own fine-tuned task-scheduler built on threading pools, encapsulates all the jobs such as encoding, decoding, updating, rendering with tasks. As a result, all the tasks could run on multi-processing. The task scheduler is readied for hiding complexity, easier integration and user convenience. Thus the policy is optional, users can select it by their demands.<br />
  33 <br />
  34 <p align="center">
  35   <img width="900" height="313" src="https://github.com/Samsung/thorvg/blob/master/res/example_thread.png">
  36 </p>
  37 <br />
  38
  39 ## Contents
  40 - [Building ThorVG](#building-thorvg)
  41         - [Meson Build](#meson-build)
  42 - [Quick Start](#quick-start)
  43 - [SVG](#svg)
  44 - [TVG Picture](#tvg-picture)
  45 - [Practices](#practices)
  46         - [Tizen](#tizen)
  47         - [Rive](#rive)
  48 - [Examples](#examples)
  49 - [Documentation](#documentation)
  50 - [Tools](#tools)
  51         - [ThorVG Viewer](#thorvg-viewer)
  52         - [SVG to PNG](#svg-to-png)
  53         - [SVG to TVG](#svg-to-tvg)
  54 - [API Bindings](#api-bindings)
  55 - [Dependencies](#dependencies)
  56 - [Issues or Feature Requests](#issues-or-feature-requests)
  57
  58 [](#contents)
  59 <br />
  60 ## Building ThorVG
  61 ThorVG supports [meson](https://mesonbuild.com/) build system.
  62 <br />
  63 ### Meson Build
  64 Install [meson](http://mesonbuild.com/Getting-meson.html) and [ninja](https://ninja-build.org/) if not already installed.
  65
  66 Run meson to configure ThorVG:
  67 ```
  68 meson build
  69 ```
  70 Run ninja to build & install ThorVG:
  71 ```
  72 ninja -C build install
  73 ```
  74 [Back to contents](#contents)
  75 <br />
  76 <br />
  77 ## Quick Start
  78 ThorVG renders vector shapes to a given canvas buffer. The following is a quick start to show you how to use the essential APIs.
  79
  80 First, you should initialize the ThorVG engine:
  81
  82 ```cpp
  83 tvg::Initializer::init(tvg::CanvasEngine::Sw, 0);   //engine method, thread count
  84 ```
  85
  86 Then it would be best if you prepared an empty canvas for drawing on it:
  87
  88 ```cpp
  89 static uint32_t buffer[WIDTH * HEIGHT];                                 //canvas target buffer
  90
  91 auto canvas = tvg::SwCanvas::gen();                                     //generate a canvas
  92 canvas->target(buffer, WIDTH, WIDTH, HEIGHT, tvg::SwCanvas::ARGB8888);  //buffer, stride, w, h, Colorspace
  93 ```
  94
  95 Next you can draw multiple shapes on the canvas:
  96
  97 ```cpp
  98 auto rect = tvg::Shape::gen();               //generate a shape
  99 rect->appendRect(50, 50, 200, 200, 20, 20);  //define it as a rounded rectangle (x, y, w, h, rx, ry)
 100 rect->fill(100, 100, 100, 255);              //set its color (r, g, b, a)
 101 canvas->push(move(rect));                    //push the rectangle into the canvas
 102
 103 auto circle = tvg::Shape::gen();             //generate a shape
 104 circle->appendCircle(400, 400, 100, 100);    //define it as a circle (cx, cy, rx, ry)
 105
 106 auto fill = tvg::RadialGradient::gen();      //generate a radial gradient
 107 fill->radial(400, 400, 150);                 //set the radial gradient geometry info (cx, cy, radius)
 108
 109 tvg::Fill::ColorStop colorStops[2];          //gradient colors
 110 colorStops[0] = {0.0, 255, 255, 255, 255};   //1st color values (offset, r, g, b, a)
 111 colorStops[1] = {1.0, 0, 0, 0, 255};         //2nd color values (offset, r, g, b, a)
 112 fill->colorStops(colorStops, 2);             //set the gradient colors info
 113
 114 circle->fill(move(fill));                    //set the circle fill
 115 canvas->push(move(circle));                  //push the circle into the canvas
 116
 117 ```
 118
 119 This code generates the following result:
 120
 121 <p align="center">
 122   <img width="416" height="411" src="https://github.com/Samsung/thorvg/blob/master/res/example_shapes.png">
 123 </p>
 124
 125 You can also draw you own shapes and use dashed stroking:
 126
 127 ```cpp
 128 auto path = tvg::Shape::gen();               //generate a path
 129 path->moveTo(199, 34);                       //set sequential path coordinates
 130 path->lineTo(253, 143);
 131 path->lineTo(374, 160);
 132 path->lineTo(287, 244);
 133 path->lineTo(307, 365);
 134 path->lineTo(199, 309);
 135 path->lineTo(97, 365);
 136 path->lineTo(112, 245);
 137 path->lineTo(26, 161);
 138 path->lineTo(146, 143);
 139 path->close();
 140
 141 path->fill(150, 150, 255, 255);              //path color
 142
 143 path->stroke(3);                             //stroke width
 144 path->stroke(0, 0, 255, 255);                //stroke color
 145 path->stroke(tvg::StrokeJoin::Round);        //stroke join style
 146 path->stroke(tvg::StrokeCap::Round);         //stroke cap style
 147
 148 float pattern[2] = {10, 10};                 //stroke dash pattern (line, gap)
 149 path->stroke(pattern, 2);                    //set the stroke pattern
 150
 151 canvas->push(move(path));                    //push the path into the canvas
 152
 153 ```
 154
 155 The code generates the following result:
 156
 157 <p align="center">
 158   <img width="300" height="300" src="https://github.com/Samsung/thorvg/blob/master/res/example_path.png">
 159 </p>
 160
 161 Now begin rendering & finish it at a particular time:
 162
 163 ```cpp
 164 canvas->draw();
 165 canvas->sync();
 166 ```
 167
 168 Then you can acquire the rendered image from the buffer memory.
 169
 170 Lastly, terminate the engine after its usage:
 171
 172 ```cpp
 173 tvg::Initializer::term(tvg::CanvasEngine::Sw);
 174 ```
 175 [Back to contents](#contents)
 176 <br />
 177 <br />
 178 ## SVG
 179
 180 ThorVG supports SVG (Scalable Vector Graphics) rendering through its SVG interpreter. It satisfies the [SVG Tiny Specification](https://www.w3.org/TR/SVGTiny12/)
 181 to keep it lightweight, so it's useful for the embedded systems. Among the SVG Tiny specs, unsupported features in the ThorVG are the following:
 182
 183  - Animation
 184  - Fonts & Text
 185  - Interactivity
 186  - Multimedia
 187  - Scripting
 188
 189 The following code snippet shows how to draw SVG image using ThorVG:
 190
 191 ```cpp
 192 auto picture = tvg::Picture::gen();         //generate a picture
 193 picture->load("tiger.svg");                 //load SVG file
 194 canvas->push(move(picture));                //push the picture into the canvas
 195 ```
 196
 197 The result:
 198
 199 <p align="center">
 200   <img width="300" height="300" src="https://github.com/Samsung/thorvg/blob/master/res/example_tiger.png">
 201 </p>
 202
 203 [Back to contents](#contents)
 204 <br />
 205 <br />
 206 ## TVG Picture
 207
 208 ThorVG provides the designated vector data format which is called TVG Picture. TVG Picture stores a list of properties of the Paint nodes of a scene in binary form. The data saved in a TVG Picture is optimized beforehand, keeping the resulting file small and the data loading process fast and efficient.
 209
 210 To save data in a TVG Picture format, ThorVG uses a dedicated module - TVG Saver. It is responsible for optimizing the data of all the scene-tree nodes and saving them in binary format. In the optimization process, the TVG Saver filters out unused information, removing the duplicated properties, merges the overlapping shapes and compresses the data if possible, but keeping the TVG Pictures compatible with the later version of ThorVG libraries. In case of compression, it uses [Lempel-Ziv-Welchi](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Welch) data compression algorithm.
 211
 212 The final data size is smaller in comparison to any other text-based vector data format, such as SVG, which in turn decreases the required application resources. This helps not only reduce the number of I/O operations but also reduces the memory bandwidth while loading the data. Thus this is effective if your program uses a big amount of the vector resources.
 213
 214 Additionally, TVG Picture helps to reduce the resource loading tasks since it can skip interpreting the data stage. That brings the reduced amount of the required runtime memory and rendering tasks that increases the performance.
 215
 216 Utilizing the TVG Picture allows you to reduce the data size and loading time by more than 30%, on average ([See More](https://github.com/Samsung/thorvg/wiki/TVG-Picture-Binary-Size)). Note that the charge in the performance rate depends on the resource size and its complexity.
 217
 218 <p align="center">
 219   <img width="909" height="314" src="https://github.com/Samsung/thorvg/blob/master/res/example_tvgsize.png">
 220 </p>
 221
 222 While TVG Saver exports the scene-tree to the TVG Picture data files(TVG), the TVG Loader imports and restores it to the programmable instances. You can quickly use the ThorVG Viewer to convert files from SVG to TVG.
 223
 224 <p align="center">
 225   <img width="710" height="215" src="https://github.com/Samsung/thorvg/blob/master/res/example_tvgmodule.png">
 226 </p>
 227
 228
 229 [Back to contents](#contents)
 230 <br />
 231 <br />
 232 ## Practices
 233 ### Tizen
 234 ThorVG is integrated into the [Tizen](https://www.tizen.org) platform as the vector graphics engine. It's being used for vector primitive drawings
 235 and scalable image contents such as SVG and Lottie Animation among the Tizen powered products.
 236
 237 <p align="center">
 238   <img width="798" height="285" src="https://github.com/Samsung/thorvg/blob/master/res/example_tizen.png">
 239 </p>
 240
 241 [Back to contents](#contents)
 242 <br />
 243 <br />
 244 ### Rive
 245 We're also building a [Rive](https://rive.app/) port that supports Rive Animation run through the ThorVG backend. Rive is a brand new animation platform
 246 that supports fancy, user-interactive vector animations. For more details see [Rive-Tizen](https://github.com/rive-app/rive-tizen) on [Github](https://github.com/rive-app/).
 247
 248 <p align="center">
 249   <img width="600" height="324" src="https://github.com/Samsung/thorvg/blob/master/res/example_rive.gif">
 250 </p>
 251
 252 [Back to contents](#contents)
 253 <br />
 254 <br />
 255 ## Examples
 256 There are various examples available in `thorvg/src/examples` to help you understand ThorVG APIs.
 257
 258 To execute these examples, you can build them with the following meson option:
 259 ```
 260 meson -Dexamples=true . build
 261 ```
 262 Note that these examples require the EFL `elementary` package for launching. If you're using Linux-based OS, you can easily
 263 install this package from your OS distribution server. Otherwise, please visit the official [EFL page](https://enlightenment.org/) for more information.
 264
 265 [Back to contents](#contents)
 266 <br />
 267 <br />
 268 ## Documentation
 269 ThorVG API documentation is available at [thorvg.org/apis](https://www.thorvg.org/apis), and can also found in the [docs](/docs) folder of this repo.
 270
 271 [Back to contents](#contents)
 272 <br />
 273 <br />
 274 ## Tools
 275 ### ThorVG Viewer
 276 ThorVG provides the resource verification tool for the ThorVG Engine. [ThorVG viewer](https://samsung.github.io/thorvg.viewer) does immediate rendering via web browser running on the ThorVG web-assembly binary, allowing real-time editing of the vector elements on it. It doesn't upload your resources to any external server while allowing to export to supported formats such as TVG, so the designer resource copyright is protected.
 277
 278 https://user-images.githubusercontent.com/71131832/130445967-fb8f7d81-9c89-4598-b7e4-2c046d5d7438.mp4
 279
 280
 281 [Back to contents](#contents)
 282 <br />
 283 <br />
 284 ### SVG to PNG
 285 ThorVG provides an executable `svg2png` converter that generates a PNG file from an SVG file.
 286
 287 To use the `svg2png`, you must turn on this feature in the build option:
 288 ```
 289 meson -Dtools=svg2png . build
 290 ```
 291 Alternatively, you can add the `svg2png` value to the `tools` option in `meson_option.txt`. The build output will be located in `{builddir}/src/bin/svg2png/`.
 292 <br />
 293
 294 To use the `svg2png` converter you have to pass the `SVG files` parameter. It can be a file name with the `.svg` extension or a directory name. Multiple files or directories separated by a space are also accepted. If a directory is passed, the `.svg` file extension is searched inside it and in all of its subdirectories.
 295
 296 Optionally, the image resolution can be provided in the `WxH` format (two numbers separated by an `x` sign) following the `-r` flag.
 297 <br />
 298 The background color can be set with the `-b` flag. The `bgColor` parameter should be passed as a three-bytes hexadecimal value in the `ffffff` format. The default background is transparent.
 299 <br />
 300 Both flags, if provided, are applied to all of the `.svg` files.
 301
 302 The usage examples of the `svg2png`:
 303 ```
 304 Usage:
 305     svg2png [SVG files] [-r resolution] [-b bgColor]
 306
 307 Flags:
 308     -r set the output image resolution.
 309     -b set the output image background color.
 310
 311 Examples:
 312     $ svg2png input.svg
 313     $ svg2png input.svg -r 200x200
 314     $ svg2png input.svg -r 200x200 -b ff00ff
 315     $ svg2png input1.svg input2.svg -r 200x200 -b ff00ff
 316     $ svg2png . -r 200x200
 317 ```
 318 [Back to contents](#contents)
 319 <br />
 320 <br />
 321 ### SVG to TVG
 322 ThorVG provides an executable `svg2tvg` converter that generates a TVG file from an SVG file.
 323
 324 To use `svg2tvg`, you must turn on this feature in the build option:
 325 ```
 326 meson -Dtools=svg2tvg . build
 327 ```
 328 Alternatively, you can add the `svg2tvg` value to the `tools` option in `meson_option.txt`. The build output will be located in `{builddir}/src/bin/svg2tvg/`.
 329
 330 Examples of the usage of the `svg2tvg`:
 331 ```
 332 Usage:
 333    svg2tvg [SVG file] or [SVG folder]
 334
 335 Examples:
 336     $ svg2tvg input.svg
 337     $ svg2tvg svgfolder
 338 ```
 339 [Back to contents](#contents)
 340 <br />
 341 <br />
 342 ## API Bindings
 343 Our main development APIs are written in C++, but ThorVG also provides API bindings for C.
 344
 345 [Back to contents](#contents)
 346 <br />
 347 <br />
 348 ## Dependencies
 349 The ThorVG core has no dependencies. However, ThorVG has optional feature extensions. Some of these have dependencies as follows:
 350
 351 * GL renderer: EGL, GLESv2
 352 * PNG support: [libpng](https://github.com/glennrp/libpng)
 353 * JPG support: [turbojpeg](https://github.com/libjpeg-turbo/libjpeg-turbo)
 354 * Examples: [EFL](https://www.enlightenment.org/about-efl.md)
 355
 356 [Back to contents](#contents)
 357 <br />
 358 <br />
 359 ## Issues or Feature Requests
 360 For support, please reach us in [Gitter](https://gitter.im/thorvg/community).