# openvg-canvas

> Canvas on node-openvg

Latest version **1.1.7** (published 2013-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install openvg-canvas
pnpm add openvg-canvas
yarn add openvg-canvas
bun add openvg-canvas
```

Provides the command `node-canvas`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2013-07-28 |
| First published | 2012-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 177 |
| Author | Luis Reis |
| Maintainers | luismreis |

## Links

- npm: https://www.npmjs.com/package/openvg-canvas
- Repository: https://github.com/luismreis/node-openvg-canvas
- Issues: https://github.com/luismreis/node-openvg-canvas/issues
- npm.io page: https://npm.io/package/openvg-canvas

## Dependencies (1)

- [openvg](https://npm.io/package/openvg.md) ~0.4.4

## Recent versions

- 1.1.7 (latest) — 2013-07-28
- 1.1.6 — 2013-07-11
- 1.1.5 — 2013-07-09
- 1.1.4 — 2013-03-07
- 1.1.3 — 2013-01-12
- 1.1.2 — 2012-12-31
- 1.1.1 — 2012-12-24
- 1.1.0 — 2012-12-20
- 1.0.0 — 2012-12-14
- 0.2.0 — 2012-12-14
- 0.1.1 — 2012-11-05
- 0.1.0 — 2012-10-21

## README

# node-openvg-canvas

[![NPM](https://nodei.co/npm/openvg-canvas.png?downloads=true&stars=true)](https://nodei.co/npm-dl/openvg-canvas/) [![NPM](https://nodei.co/npm-dl/openvg-canvas.png)](https://nodei.co/npm-dl/openvg-canvas/)

## Canvas implementation on node-openvg

This module implements a HTML5 Canvas on top of OpenVG (node-openvg). It is targeted to the raspberry-pi.
By using the OpenVG APIs on the Raspberry PI, all graphics code will run on the GPU with hardware acceleration.

This library aims for API compatibility with [node-canvas](https://github.com/learnboost/node-canvas) where it applies and makes sense. While node-canvas is targeted to create images off screen, node-openvg-canvas is targeted to main screen usage, but not yet for user interaction.

Currently there are only plans to implement the 2d context. Implementing the 3d context (web gl) should be possible by mapping OpenGL/ES.

## 0. Installation

This module has been tested on node 0.8, 0.10 and 0.11. Official node binaries for the
raspberry pi can be found be clicking at "Other release files" link that accompanies every
node release announcement, [example](http://nodejs.org/dist/v0.11.4/).

### Prerequisites

node-openvg-canvas depends on freetype and freeimage. To install these libraries
on the raspberry - assuming a raspbian distribution - use:

    sudo apt-get install libfreetype6 libfreetype6-dev libfreeimage3 libfreeimage-dev

### Source code install

Fetch the source:

    git clone https://github.com/luismreis/node-openvg-canvas.git

Build the package:

    cd node-openvg-canvas
    npm install

To test:

    export PATH=$PWD/bin:$PATH
    examples/swissClock.js

### NPM / module install

Run on your command line:

    npm install openvg-canvas --save

## 1. Documentation

### Reference

* [WHATWG](http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html)
* [w3c](http://www.w3.org/TR/2dcontext/)

### Canvas implementation status

The project now implements the full HTML 5 Canvas Level 1 specification, plus most of
the non interactive features of Level 2. The current focus on the project for releases in the short term is performance.

Items marked as "✘" are not planned for implementation. Some due to insufficient information (eg. focus ring), others because they don't make sense in this implementation (eg. scrollPathIntoView).

<table>
  <thead>
    <tr><th>Object / Feature</th><th>Status</th><th>Notes</th></tr>
  </thead>
  <tbody>
    <tr><td>CanvasRenderingContext2D</td><td></td><td></td></tr>
    <tr><td>- state - save/restore</td><td>✔</td><td></td></tr>
    <tr><td>- matrix transformations: scale, transform, etc</td><td>✔</td><td></td></tr>
    <tr><td>- compositing - alpha, composite operation</td><td>✔</td><td></td></tr>
    <tr><td>- image smoothing</td><td>✔</td><td></td></tr>
    <tr><td>- stroke/fill style</td><td>✔</td><td></td></tr>
    <tr><td>- solid colors</td><td>✔</td><td></td></tr>
    <tr><td>- gradients</td><td>✔</td><td></td></tr>
    <tr><td>- patterns</td><td>✔</td><td><br>(see below)</td></tr>
    <tr><td>- shadows</td><td>✔</td><td></td></tr>
    <tr><td>- clear/fill/stroke rect</td><td>✔</td><td></td></tr>
    <tr><td>- beginPath, paths / path methods, fill, stroke</td><td>✔</td><td></td></tr>
    <tr><td>- focus ring</td><td>✘</td><td></td></tr>
    <tr><td>- scrollPathIntoView</td><td>✘</td><td></td></tr>
    <tr><td>- clipping region</td><td>✔</td><td></td></tr>
    <tr><td>- isPointInPath</td><td>to do</td><td>Support planned.</td></tr>
    <tr><td>- fill/stroke text</td><td>✔</td><td></td></tr>
    <tr><td>- measure text</td><td>✔</td><td>hanging and ideographic baselines not implemented.</td></tr>
    <tr><td>- drawImage</td><td>✔</td><td></td></tr>
    <tr><td>- hit regions</td><td>✘</td><td></td></tr>
    <tr><td>- create/get/put image data</td><td>✔</td><td></td></tr>
    <tr><td>CanvasDrawingStyles</td><td></td><td></td></tr>
    <tr><td>- line caps/joins - line width, cap, join, miter limit</td><td>✔</td><td></td></tr>
    <tr><td>- dashed lines</td><td>✔</td><td></td></tr>
    <tr><td>- text - font, textAlign, textBaseline</td><td>✔</td><td></td></tr>
    <tr><td>CanvasPathMethods</td><td>✔</td><td></td></tr>
    <tr><td>- beginPath</td><td>✔</td><td>Also available on the Path object.</td></tr>
    <tr><td>- moveTo, lineTo</td><td>✔</td><td></td></tr>
    <tr><td>- quadraticCurveTo, bezierCurveTo</td><td>✔</td><td>Untested</td></tr>
    <tr><td>- arcTo</td><td>✔</td><td>Implemented Canvas Level 2 (elliptical arcs)</td></tr>
    <tr><td>- rect</td><td>✔</td><td></td></tr>
    <tr><td>- arc</td><td>✔</td><td></td></tr>
    <tr><td>- ellipse</td><td>✔</td><td></td></tr>
    <tr><td>CanvasGradient</td><td>✔</td><td></td></tr>
    <tr><td>- addColorStop</td><td>✔</td><td></td></tr>
    <tr><td>CanvasPattern</td><td>✔</td><td>OpenVG doesn't support one-directional patterns. For now only 'no-repeat' and 'repeat' work as expected.</td></tr>
    <tr><td>- setTransform</td><td>to do</td><td>Planned.</td></tr>
    <tr><td>TextMetrics</td><td>✔</td><td></td></tr>
    <tr><td>HitRegionOptions</td><td>✘</td><td></td></tr>
    <tr><td>ImageData</td><td>✔</td><td></td></tr>
    <tr><td>Path</td><td>✔</td><td>(see CanvasPathMethods)</td></tr>
    <tr><td>- (constructor)</td><td>✔</td><td>SVG path constructor after v1.0</td></tr>
    <tr><td>- addPath</td><td>✔</td><td></td></tr>
    <tr><td>- addPathByStrokingPath</td><td>✘</td><td></td></tr>
    <tr><td>- addText</td><td>✔</td><td>Position and Path variants</td></tr>
    <tr><td>- addPathByStrokingText</td><td>✘</td><td></td></tr>
  </tbody>
</table>

### Differences from the HTML5 Canvas object / node-canvas

On browsers, the Canvas rendering is controlled by the browser runtime - this is referred in the w3c docs as the ' "update the rendering" step'.

On node-canvas, user code explicitly calls toBuffer or similar functions to produce output. Note that this behavior can be reproduced on node-openvg-canvas by calling ImageData.saveToBuffer and/or Canvas.toBuffer.

Code running on node-openvg-canvas must explicitly swap display buffers, to do so, either call ```Canvas.vgSwapBuffers()``` or use the included requestAnimationFrame shim that does this after calling your paint callback function (for more information look at the clock examples).

## Some sample screenshots
The code to produce these screenshots is included in the examples.

### Colors parsing
examples/color.js

![Color](https://raw.github.com/luismreis/node-openvg-canvas/master/examples/screenshots/color.png)

### Clipping
examples/clipping.js

![Clipping](https://raw.github.com/luismreis/node-openvg-canvas/master/examples/screenshots/clipping.png)

### Alpha
examples/globalAlpha.js

![globalAlpha](https://raw.github.com/luismreis/node-openvg-canvas/master/examples/screenshots/globalAlpha.png)

### Shadows
examples/clipping.js

![Shadows](https://raw.github.com/luismreis/node-openvg-canvas/master/examples/screenshots/shadows.png)

### Text along paths
examples/pathText.js

![Path Text](https://raw.github.com/luismreis/node-openvg-canvas/master/examples/screenshots/pathText.png)

## License

(The MIT License)

Copyright (c) 2012, 2013 Luis Reis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

====

This module used to depend on node-image (BSD license) [npm](https://npmjs.org/package/node-image) / [github](https://github.com/mikeseven/node-image) for image loading/saving, currently, it has it's own [FreeImage](http://freeimage.sourceforge.net/license.html) bindings.

====

Font loading and rendering via [FreeType](http://www.freetype.org/) is based on code originaly from [Hybrid Graphics, Ltd](http://web.archive.org/web/20070808195023/http://developer.hybrid.fi/font2openvg/index.html) (BSD license).

---
_Source: https://npm.io/package/openvg-canvas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._