Skip to content
nimbasePublic

About

2D Vector Graphics Engine in Nim. CPU (opt-in JIT) & GPU rendering

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

71 Commits

Folders and files

Repository files navigation

Pure-Nim 2D Vector Graphics (NanoVG-inspired)

nimble install nvg / clue install nvg

API reference
Github Actions Github Actions

Features

  • CPU and GPU rendering: a scalar rasterizer, an opt-in JIT backend, and a Metal GPU backend — pixel-identical output on every backend
  • Draw with a simple canvas: shapes, fills, strokes, transparency
  • Smooth edges everywhere through supersampled antialiasing
  • Gradients (linear, radial, box — with as many color stops as you like), image patterns, solid colors
  • Mipmapped image sampling, so minified images stay smooth instead of aliasing
  • Photo filters: monochrome and color grain (uniform and soft), plus ripple, swirl, motion blur, turbulence fields and domain-warp distortion, on both CPU and Metal compute
  • Dominant-color extraction: N predominant colors of any picture as opaque swatches (dominantColors, --palette N on the effects CLI)
  • SVG image loading straight into pattern paints
  • Flexible strokes: round/square caps, miter/bevel/round joins, dashed lines
  • Two fill rules (even-odd, nonzero winding) for holes and overlaps
  • 26 blend modes: Porter-Duff plus the full CSS mix-blend set
  • Masks and offscreen layers for cutouts and compositing tricks
  • Stars, polygons, rounded corners, plus measuring/splitting paths
  • Text rendering: harfnim shaping (kerning, ligatures, Arabic joining, RTL) with glyph outlines as fills and strokes, multiline + alignment
  • Flexbox-style text rows: inline images, paths and rectangles that align to the text (baseline, center, top, bottom, stretch), with row justification, gaps and growth — including the footer-icon pattern, no hand-positioning needed
  • An opt-in JIT backend that renders pixel-identical output, faster
  • PNG export with zero dependencies (pure-Nim encoder)
  • Image file loading: PNG, JPEG, BMP, GIF, QOI, PNM, TGA decode into pattern paints, no dependencies beyond the workspace

Examples

import nvg

let c = newCanvas(800, 600)
c.clear(rgb(255, 255, 255))
c.beginPath()
c.circle(400, 300, 200)
c.setFillPaint(c.radialGradient(400, 300, 20, 200,
  rgbf(0.9, 0.2, 0.2), rgbf(0.2, 0.2, 0.9)))
c.fill()
c.savePng("out.png")

Faster rendering with the JIT backend (same pixels, guaranteed). Compile with -d:nvgJit (this keeps the kernel builders out of normal builds, so everyday compiles stay fast):

# nim c -d:nvgJit myapp.nim
let c = newCanvas(800, 600, newJitBackend())
# ... draw as usual ...
destroyJitBackend(c.backend.JitBackend)

Every file in examples/ is a standalone program that renders PNGs into examples/out/ (gitignored; pass another directory as the first argument to override). Run them all with for f in examples/*.nim; do nim c -r "$f"; done — three need extra setup (see notes):

file renders run notes
basic.nim shapes, solid fills/strokes, translucent overlap —
gradients.nim linear, radial, box, multi-stop (+ hard stop) —
strokes.nim caps, joins, dashes —
patterns.nim image patterns: clamp/repeat/flip/tint, bilinear —
blends.nim composite ops over a shared backdrop —
masks.nim offscreen layers + alpha masks —
paths.nim stars, polygons, fill rules, path measurement —
images.nim image file loading into pattern paints (renders its own source image, no assets needed) —
svg.nim SVG subset rendering: direct PNG plus registry pattern fill/stroke —
text.nim sizes, 3x4 alignment grid, spacing, line height, paints needs a font: nim c -r examples/text.nim -- /path/to/font.ttf
textbox.nim wrap, align, justify, box valign, overflow, fit needs a font (same -- form as text.nim)
midsummer.nim A4 book pages of Midsummer II.1 with line guides needs a font (same -- form)
jit.nim CPU vs JIT backend, pixel-identity check nim c -r -d:nvgJit examples/jit.nim
gpu.nim every backend feature in one scene, plus blur Metal backend, needs a font (same -- form)
kaleidoscope.nim mirrored photo wedges CPU by default, Metal with -d:nvgMetal
effects.nim photo effects CLI: mosaic, blur, gauss, sharpen, mono/color grain (uniform + soft), ripple, swirl, motion blur, turbulence, domain warp; --palette N prints dominant colors defaults to tests/data/pexels-tubusan-5773749.jpg; --backend metal needs -d:nvgMetal
filters.nim the same filters on a synthetic scene no photo needed; two motion-blur angles (25°, 115°)

Roadmap

Full scope and acceptance criteria live in ROADMAP.md.

  • CPU rasterizer with antialiased edges
  • Paths, transforms, scissor clips
  • Solid, gradient (multi-stop) and pattern paints
  • Strokes: caps, joins, dashes
  • Even-odd and nonzero winding fills
  • Blend modes (Porter-Duff + full CSS mix-blend set)
  • Mask and layer compositing primitives
  • Stars, polygons, path measurement and splitting
  • JIT backend, pixel-identical to scalar
  • Metal GPU backend (needs hosted-GPU verification)
  • Mipmapped image minification
  • All 26 blend modes on the JIT fast path (separable + non-separable)
  • PNG export without dependencies
  • Text rendering (shaping + glyph outlines, multiline + align)
  • Flex row lines (justify, gap, grow, item alignment)
  • Inline replaced boxes (image/path spans aligned to text ink)
  • Bilinear and multi-stop paints on the JIT fast path
  • AArch64 kernel execution sign-off
  • Image file loading API
  • Photo filters (mono/color grain, ripple, swirl, motion blur, turbulence, domain warp) on CPU + Metal compute
  • Dominant-color extraction (dominantColors, --palette N)
  • SVG image loading (v1 subset: shapes, paths, gradients, transforms)

❤ Contributions & Support

🎩 License

MIT license | Nim Community.

About

2D Vector Graphics Engine in Nim. CPU (opt-in JIT) & GPU rendering

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages