https://github.com/jackdbd/zig-cairo

🪲 zig-idiomatic wrapper for cairo
https://github.com/jackdbd/zig-cairo

cairo graphics wrapper zig

Last synced: 12 months ago
JSON representation

🪲 zig-idiomatic wrapper for cairo

• Host: GitHub
• URL: https://github.com/jackdbd/zig-cairo
• Owner: jackdbd
• License: other
• Created: 2021-01-12T23:44:55.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-04-07T20:33:21.000Z (about 4 years ago)
• Last Synced: 2025-02-23T17:37:25.481Z (over 1 year ago)
• Topics: cairo, graphics, wrapper, zig
• Language: Zig
• Homepage:
• Size: 904 KB
• Stars: 20
• Watchers: 2
• Forks: 5
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# zig-cairo

[![CI](https://github.com/jackdbd/zig-cairo/actions/workflows/ci.yaml/badge.svg)](https://github.com/jackdbd/zig-cairo/actions/workflows/ci.yaml)

Thin wrapper for the [cairo](https://github.com/freedesktop/cairo) 2D graphics library.

Tested on Zig version **0.9.1**.

🚧 Very much a work in progress... 🚧

## Naming convention

As suggested in the [cairo Appendix](https://www.cairographics.org/manual/language-bindings.html), the type names and method names of the original C library were changed to follow the [Zig Style Guide](https://ziglang.org/documentation/0.7.1/#Names). For example, a method like `cairo_set_source(cr, source)` in cairo becomes `cr.setSource(source)` in zig-cairo.

## Installation

Clone the repo and jump into it:

```sh

git clone git@github.com:jackdbd/zig-cairo.git

cd zig-cairo

```

In order to use this library and run the examples you will need zig version **0.9.1**. You can get it using [zigup](https://github.com/marler8997/zigup):

```sh

zigup fetch 0.9.1

zigup 0.9.1

```

You will also need [cairo](https://www.cairographics.org/), [pango](https://gitlab.gnome.org/GNOME/pango), [pangocairo](https://docs.gtk.org/PangoCairo/), [xcb](https://xcb.freedesktop.org/), and [xvfb](https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml) if you want to run some tests/examples in a virtual framebuffer. See [this script](./scripts/install-dependencies.sh).

## Examples

You can find many examples in the [examples directory](./examples/README.md).

![arc.zig](./examples/generated/arc.png)

![arc_negative.zig](./examples/generated/arc_negative.png)

![curve_to.zig](./examples/generated/curve_to.png)

![fill_style.zig](./examples/generated/fill_style.png)

![gradient.zig](./examples/generated/gradient.png)

![image.zig](./examples/generated/image.png)

![spiral.zig](./examples/generated/spiral.png)

![spirograph.zig](./examples/generated/spirograph.png)

![compositing.zig](./examples/generated/compositing.png)

![pango_simple.zig](./examples/generated/pango_simple.png)

Run `zig build --help` to see all the compilation targets.

Most examples generate a PNG. Here I use [feh](https://feh.finalrewind.org/) to view the generated file:

```sh

zig build rounded_rectangle && feh examples/generated/rounded_rectangle.png

zig build spirograph && feh examples/generated/spirograph.png

zig build text_extents && feh examples/generated/text_extents.png

```

A few examples generate a SVG:

```sh

zig build surface_svg && inkscape examples/generated/test-image.svg

```

Some other examples don't generate any image file. This one opens a window and renders cairo graphics inside of it (using a cairo [XCB](https://xcb.freedesktop.org/) surface):

```sh

zig build surface_xcb

```

If you installed [XVFB](https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml) you can also run this example in a virtual framebuffer:

```sh

xvfb-run --server-args="-screen 0 1024x768x24" zig build surface_xcb

```

## Tests

```sh

# run all tests, in all modes (debug, release-fast, release-safe, release-small)

zig build test

# run all tests, only in debug mode

zig build test-debug

```