Módulos

A API Ink é modularizada, então você pode usar apenas o que precisa.

Braçadas

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.

Geometria

O módulo Geometry oferece suporte a operações geométricas em formas primitivas (usando classes dedicadas como Box e Vec), além de formas arbitrárias (usando PartitionedMesh), incluindo detecção e transformação de interseção. O PartitionedMesh também pode conter dados extras para oferecer suporte à renderização.

Brush

O módulo brush define o estilo dos traços. Ela é composta por duas partes principais:

• Brush: especifica o estilo de um traço, incluindo cor base, tamanho base e BrushFamily. BrushFamily é análogo a uma família de fontes, definindo o estilo de um traço. Por exemplo, um BrushFamily pode representar um estilo específico de marcador ou destaque, permitindo que traços com tamanhos e cores diferentes compartilhem esse estilo.
• StockBrushes: fornece funções de fábrica para criar instâncias BrushFamily prontas para uso.

Criação

O módulo Authoring do Compose permite capturar a entrada de toque do usuário e renderizá-la como traços de baixa latência na tela em tempo real. Isso é feito com o elemento combinável InProgressStrokes, que processa eventos de movimento e mostra os traços à medida que são desenhados.

Quando um traço é concluído, o elemento combinável notifica o aplicativo cliente usando um callback InProgressStrokesFinishedListener. Isso permite que o aplicativo recupere os traços finalizados para renderização ou armazenamento.

No Compose, InProgressStrokes usa esse callback no parâmetro onStrokesFinished. Transmita os traços concluídos para outro elemento combinável para confirmar na tela usando o módulo de renderização.

Renderização

O módulo Rendering simplifica o desenho de traços de tinta em um Canvas do Android. Ele fornece CanvasStrokeRenderer para o Compose e ViewStrokeRenderer para layouts baseados em visualizações. Esses renderizadores otimizam o desempenho da renderização e ajudam a oferecer recursos visuais de alta qualidade, incluindo antialiasing.

Para renderizar traços, chame o método create() para receber uma instância de CanvasStrokeRenderer e, em seguida, chame o método draw() para renderizar traços concluídos (Stroke) ou em andamento (InProgressStroke) em um Canvas.

É possível transformar a tela ao desenhar um traço. Exemplos incluem panorâmica, zoom e rotação. Para renderizar o traço corretamente, também é necessário transmitir a transformação canvas para CanvasStrokeRenderer.draw.

Para evitar o rastreamento da transformação canvas separadamente, use ViewStrokeRenderer.

Armazenamento

The storage module provides utilities for efficiently serializing and deserializing stroke data, primarily focusing on StrokeInputBatch.

The module uses protocol buffers and optimized delta compression techniques, resulting in significant storage savings compared to naive methods.

The storage module simplifies saving, loading, and sharing strokes.