plutovg-sys 0.0.1

Low-level bindings to the PlutoVG vector graphics library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# plutovg-sys

[![Crates.io](https://img.shields.io/crates/v/plutovg-sys)](https://crates.io/crates/plutovg-sys)
[![Documentation](https://docs.rs/plutovg-sys/badge.svg)](https://docs.rs/plutovg-sys)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

FFI bindings to [PlutoVG](https://github.com/sammycage/plutovg), a 2D vector graphics library written in C.

## About PlutoVG

PlutoVG is a standalone 2D vector graphics library that provides:
- Vector path rendering
- Text rendering with font support
- Various paint types (solid colors, gradients, patterns)
- Transformations and clipping
- Export to PNG format

## Features

- Raw FFI bindings to the complete PlutoVG C API
- Safe Rust constants for mathematical values (π, √2, etc.)
- Automatic building and linking of the PlutoVG C library
- Cross-platform support

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
plutovg-sys = "0.0.1"
```

## Usage

This crate provides low-level FFI bindings. All functions are `unsafe` and require manual memory management.

### Basic Example

```rust
use plutovg_sys::*;
use std::ffi::CString;

unsafe {
    // Create a 400x400 surface
    let surface = plutovg_surface_create(400, 400);
    let canvas = plutovg_canvas_create(surface);
    
    // Draw a red circle
    plutovg_canvas_arc(canvas, 200.0, 200.0, 100.0, 0.0, PLUTOVG_TWO_PI, false);
    plutovg_canvas_set_rgb(canvas, 1.0, 0.0, 0.0); // Red
    plutovg_canvas_fill(canvas);
    
    // Save to PNG
    let filename = CString::new("circle.png").unwrap();
    plutovg_surface_write_to_png(surface, filename.as_ptr());
    
    // Clean up
    plutovg_canvas_destroy(canvas);
    plutovg_surface_destroy(surface);
}
```

### Smiley Face Example

Run the included example to generate a smiley face:

```bash
cargo run --example basic
```

This creates a `smiley.png` file with a yellow smiley face.

## Constants

The crate provides mathematical constants as `f32` values:

- `PLUTOVG_PI` - π (3.141592...)
- `PLUTOVG_TWO_PI` - 2π
- `PLUTOVG_HALF_PI` - π/2
- `PLUTOVG_SQRT2` - √2
- `PLUTOVG_KAPPA` - κ (0.552284...)

## Building

This crate uses `bindgen` to generate Rust bindings and `cc` to compile the PlutoVG C library. The build process:

1. Compiles all PlutoVG C source files
2. Generates Rust bindings from the C headers
3. Links everything together

### Requirements

- A C compiler (GCC, Clang, or MSVC)
- Rust 2024 edition

## Safety

⚠️ **All functions in this crate are `unsafe`**

You must ensure:
- Proper initialization and cleanup of surfaces and canvases
- Valid pointer management
- Correct order of operations (create surface before canvas, etc.)
- No use-after-free errors

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

The bundled PlutoVG library is also MIT licensed.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Links

- [PlutoVG GitHub Repository](https://github.com/sammycage/plutovg)
- [Crates.io](https://crates.io/crates/plutovg-sys)
- [Documentation](https://docs.rs/plutovg-sys)