pixie/README.md

79 lines
1.6 KiB
Markdown
Raw Normal View History

2020-11-21 05:09:52 +00:00
# Pixie - A full-featured 2D graphics library for Nim
2020-11-20 02:41:32 +00:00
2020-11-21 05:09:52 +00:00
⚠️ WARNING: This library is still in heavy development. ⚠️
2020-11-20 17:13:53 +00:00
2020-11-27 21:51:40 +00:00
Pixie is a 2D graphics library similar to [Cairo](https://www.cairographics.org/) and [Skia](https://skia.org) written (almost) entirely in Nim.
2020-11-20 17:13:53 +00:00
2020-11-21 05:09:52 +00:00
Features include:
* Drawing paths, shapes and curves
* Complex masking
* Shadows, glows and effects
2020-12-04 16:17:03 +00:00
* Loading image file formats (PNG, BMP, JPG, SVG + more in development)
2020-11-21 05:09:52 +00:00
This library is being actively developed and is not yet ready for use. Since you've managed to stumble onto it, give it a star and check back soon!
## Testing
`nimble test`
2020-12-01 17:49:41 +00:00
## Examples
2020-12-04 17:41:28 +00:00
### Blur
[examples/blur.nim](examples/blur.nim)
2020-12-04 16:32:03 +00:00
```nim
2021-01-29 20:17:24 +00:00
var p: Path
2020-12-04 17:32:38 +00:00
p.polygon(100, 100, 70, sides=6)
2020-12-04 16:32:03 +00:00
p.closePath()
2021-01-29 20:17:24 +00:00
2021-02-09 04:50:39 +00:00
let mask = newMask(200, 200)
mask.fillPath(p)
2021-01-29 20:17:24 +00:00
2020-12-04 17:43:33 +00:00
blur.blur(20)
2020-12-04 16:32:03 +00:00
blur.draw(mask, blendMode = bmMask)
2021-01-29 20:17:24 +00:00
2020-12-04 16:32:03 +00:00
image.draw(trees)
image.draw(blur)
```
![example output](examples/blur.png)
2020-12-04 17:41:28 +00:00
### Rounded rectangle
[examples/rounded_rectangle.nim](examples/rounded_rectangle.nim)
2020-12-01 17:49:41 +00:00
```nim
let
x = 50.0
y = 50.0
w = 100.0
h = 100.0
2020-12-04 17:33:58 +00:00
r = 25.0
2021-01-29 20:17:24 +00:00
var path: Path
2021-02-09 04:50:39 +00:00
path.roundedRect(vec2(x, y), vec2(w, h), r, r, r, r)
2021-01-29 20:17:24 +00:00
2020-12-01 17:49:41 +00:00
image.fillPath(path, rgba(255, 0, 0, 255))
```
![example output](examples/rounded_rectangle.png)
2020-12-04 17:41:28 +00:00
### Square
[examples/square.nim](examples/square.nim)
2020-12-01 17:49:41 +00:00
```nim
2021-01-29 20:17:24 +00:00
var p: Path
2021-02-09 04:50:39 +00:00
p.rect(50, 50, 100, 100)
2021-01-29 20:17:24 +00:00
2020-12-01 17:49:41 +00:00
image.fillPath(p, rgba(255, 0, 0, 255))
```
![example output](examples/square.png)
2020-12-04 17:41:28 +00:00
### Tiger
[examples/tiger.nim](examples/tiger.nim)
```nim
2021-01-29 20:17:24 +00:00
let tiger = readImage("examples/data/tiger.svg")
image.draw(
tiger,
translate(vec2(100, 100)) *
scale(vec2(0.2, 0.2)) *
translate(vec2(-450, -450))
)
```
![example output](examples/tiger.png)