Expand description
Rust bindings for Google Ink, the freehand stroke library behind Android Jetpack Ink.
Give it sampled pointer events and a brush; get back smoothed, modelled triangle meshes to draw.
§How the bindings are put together
Ink’s public API is built on absl::StatusOr, absl::Span and templates,
none of which cross an FFI boundary directly. So this crate is two layers:
- A small C++ facade (
crates/ink-rs/cc/ink_ffi.h) that restates the parts of Ink we use in plain structs, enums and pointers, with C linkage. - This crate, which wraps the generated declarations in owned types with
Drop, turns status codes intoResult, and swaps Ink’s sentinel values forOption.
The declarations in between are generated from the header by bindgen and checked in, so building needs neither bindgen nor libclang.
Adding to the bindings means adding to the facade first. See
docs/ink-bindings.md.
§Threading
Ink’s types are not thread-safe, and neither are these. Brush,
Stroke and friends are deliberately neither Send nor Sync: build and
read a stroke on one thread, and move the plain Mesh data if another
thread needs it.
§Example
use std::time::Duration;
use ink_rs::{Brush, Color, InProgressStroke, Point, StockBrush, StrokeInput, StrokeInputBatch, ToolType};
let family = StockBrush::PressurePen.family();
let brush = Brush::new(&family, Color::from_packed_rgba(0x1a1a1aff), 4.0, 0.1)?;
let mut stroke = InProgressStroke::new();
stroke.start(&brush);
// Feed in pointer events as they arrive.
let inputs = StrokeInputBatch::new(&[
StrokeInput::new(ToolType::Stylus, Point::new(10.0, 10.0), Duration::ZERO)
.with_pressure(0.4),
StrokeInput::new(ToolType::Stylus, Point::new(22.0, 18.0), Duration::from_millis(16))
.with_pressure(0.7),
])?;
stroke.enqueue_inputs(&inputs, None)?;
stroke.update_shape(Duration::from_millis(16))?;
// Draw it.
for coat in 0..stroke.coat_count() {
let mesh = stroke.coat_mesh(coat);
println!("{} triangles", mesh.triangle_count());
}
// Keep it once the pen lifts.
stroke.finish_inputs();
stroke.update_shape(Duration::from_millis(32))?;
let finished = stroke.to_stroke();Structs§
- Brush
- A brush family together with a colour, a size and an epsilon.
- Brush
Family - The shape and behaviour half of a brush, without colour or size.
- Color
- A colour, together with how to interpret its components.
- Error
- A failure reported by Ink, with the message it came with.
- InProgress
Stroke - A stroke being drawn.
- Mesh
- A snapshot of triangle geometry, ready to hand to a renderer.
- Point
- A position in stroke units.
- Rect
- An axis-aligned bounding box.
- Stroke
- A finished stroke: the input, the brush, and the geometry generated from the two.
- Stroke
Input - One sampled input event.
- Stroke
Input Batch - An ordered run of
StrokeInputs. - Vec2
- A displacement in stroke units.
Enums§
- Color
Format - How a colour’s components are encoded.
- Color
Space - The colour space a colour’s components are expressed in.
- Error
Kind - The kind of failure Ink reported.
- Stock
Brush - One of Ink’s built-in brush families.
- Tool
Type - What produced an input event.
Type Aliases§
- Result
- Result type used throughout this crate.