Modules

L'Ink API est modularisée. Vous pouvez donc n'utiliser que ce dont vous avez besoin.

Traits

The strokes module serves as the foundation of the Ink API. Key data types within this module are:

• StrokeInputBatch: Represents a series of pointer inputs, including their position, timestamp, and optionally pressure, tilt, and orientation.
• InProgressStroke: Represents a stroke that is actively being drawn. InProgressStroke is used to render partial strokes with low latency and to build the final Stroke once input is complete, after which the object can be reused. InProgressStroke is used by the InProgressStrokes composable.
• Stroke: An immutable representation of a finalized stroke with fixed geometry. Each Stroke has an ImmutableStrokeInputBatch (input points), a Brush (style), and a PartitionedMesh (geometric shape). You can store, manipulate, and render strokes within your application.

Géométrie

The Geometry module supports geometric operations on primitive shapes (using dedicated classes like Box and Vec), as well as arbitrary shapes (using PartitionedMesh), including intersection detection and transformation. PartitionedMesh can also hold additional data to support rendering.

Pinceau

The brush module defines the style of strokes. It consists of two main parts:

• Brush: Specifies the style of a stroke including base color, base size, and BrushFamily. BrushFamily is analogous to a font family, it defines a stroke's style. For example, a BrushFamily can represent a specific style of marker or highlighter, allowing strokes with different sizes and colors to share that style.
• StockBrushes: Provides factory functions for creating ready-to-use BrushFamily instances.

Création

The Compose Authoring module lets you capture user touch input and render it as low-latency strokes on the screen in real time. This is achieved through the InProgressStrokes composable, which processes motion events and displays the strokes as they are drawn.

Once a stroke is completed, the composable notifies the client application using an InProgressStrokesFinishedListener callback. This allows the application to retrieve the finished strokes for rendering or storage.

In Compose, InProgressStrokes takes this callback in the onStrokesFinished parameter. Pass the finished strokes to another composable to commit them to the screen using the rendering module.

Affichage

Le module Rendering simplifie le dessin de traits d'encre sur un Canvas Android. Il fournit CanvasStrokeRenderer pour Compose et ViewStrokeRenderer pour les mises en page basées sur les vues. Ces renderers optimisent les performances de rendu et permettent de fournir des visuels de haute qualité, y compris l'anticrénelage.

Pour afficher les traits, appelez la méthode create() pour obtenir une instance CanvasStrokeRenderer, puis appelez la méthode draw() pour afficher les traits terminés (Stroke) ou en cours (InProgressStroke) sur un Canvas.

Vous pouvez transformer le canevas lorsque vous dessinez un trait. Par exemple, le déplacement, le zoom et la rotation. Pour afficher correctement le trait, vous devez également transmettre la transformation canvas à CanvasStrokeRenderer.draw.

Pour éviter de suivre la transformation canvas séparément, utilisez plutôt ViewStrokeRenderer.

Stockage

Le module storage fournit des utilitaires pour sérialiser et désérialiser efficacement les données de traits, en se concentrant principalement sur StrokeInputBatch.

Le module utilise des protocol buffers et des techniques de compression delta optimisées, ce qui permet de réaliser des économies de stockage importantes par rapport aux méthodes naïves.

Le module de stockage simplifie l'enregistrement, le chargement et le partage des traits.