Módulos

La API de Ink está modularizada, por lo que puedes usar solo lo que necesitas.

Brazadas

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 InProgressStrokesView.
  • 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.

Geometría

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.

Pincel

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.

Autoría

El módulo Authoring te permite capturar la entrada del puntero del usuario y renderizarla como trazos de baja latencia en la pantalla en tiempo real. Proporciona un InProgressStrokesView, que procesa eventos de movimiento y muestra los trazos a medida que se dibujan.

Una vez que se completa un trazo, la vista notifica a la aplicación cliente a través de una devolución de llamada registrada (InProgressStrokesFinishedListener). La devolución de llamada permite que la aplicación recupere el trazo terminado para su procesamiento o almacenamiento.

Renderización

El módulo de renderización te ayuda a dibujar trazos de tinta en un Canvas de Android. Proporciona CanvasStrokeRenderer para Compose y ViewStrokeRenderer para diseños basados en vistas. Estos renderizadores están diseñados para un renderizado de alto rendimiento y ayudan a ofrecer imágenes de alta calidad, incluido el suavizado.

Para renderizar trazos, llama al método create() para obtener una instancia de CanvasStrokeRenderer. Luego, llama al método draw() para renderizar trazos terminados (Stroke) o en curso (InProgressStroke) en un objeto Canvas.

Puedes transformar el lienzo cuando dibujas un trazo. Algunos ejemplos incluyen el desplazamiento horizontal, el zoom y la rotación. Para renderizar el trazo correctamente, también debes pasar la transformación canvas a CanvasStrokeRenderer.draw.

Para evitar hacer un seguimiento de la transformación canvas por separado, usa ViewStrokeRenderer.

Almacenamiento

El módulo storage proporciona utilidades para serializar y deserializar de manera eficiente los datos de trazos, principalmente enfocándose en StrokeInputBatch.

El módulo usa búferes de protocolo y técnicas de compresión delta optimizadas, lo que genera un ahorro de almacenamiento significativo en comparación con los métodos básicos.

El módulo de almacenamiento simplifica el guardado, la carga y el uso compartido de trazos.