Repository files navigation

The Ink library is a freehand stroke generation library. It produces smoothed,modeled stroke shapes with brush effect shaders as mesh-based vector graphics.

This library provides the core of the implementation of the Android JetpackInk module, whichis currently in alpha. While the implementation is well-tested, the developersof this library are not currently making hard guarantees about interfacestability. We probably will attempt to introduce a versioned release processafter the Jetpack module stable release.

• Bazel 7:https://bazel.build/install
• Android NDK:https://developer.android.com/ndk/downloads
  • Download and setANDROID_NDK_HOME to point to it.
  • Alternately usesdkmanager or Android Studio:https://developer.android.com/studio/projects/install-ndk
• You may need to install libtinfo for clang
  • sudo apt-get install libtinfo5

Ink can be built and tested from the repo root:

bazeltest --config=linux ink/...

Ink consists of a set of modules that can be used separately. You should onlyneed to include the parts of the library that you need.

 ┌──────────┐ ┌───────┐ │Rendering │ │Storage│ └────┬─────┘ └──┬────┘      │          │      ▼          │   ┌───────┐     │   │Strokes│◄────┘   └─┬────┬┘     │    │     │    ▼     │ ┌────────┐     │ │Geometry│     │ └───┬────┘     │     │     ▼     ▼ ┌─────┐ ┌─────┐ │Color│ │Types│ └─────┘ └─────┘

• color: color spaces, encoding, and format conversion.
• types: utility types; time, units, constants, small arrays.
• geometry: geometric types (point, segment, triangle, rect, quad), meshes,transforms, utility functions, and algorithms (intersection, envelope).
• strokes: the primaryStroke data type andInProgressStroke builder.
• rendering: rendering utilities for strokes. Currently only has support forandroid.graphics.Mesh based rendering.
• storage: Protobuf serialization utilities forStroke and related types.

SeeCONTRIBUTING.md for details on sending a PR.

Use GitHub Issues to file feedback:https://github.com/google/ink/issues