kitepdf-native-renderer/io.github.yuroyami.kitepdf.nativerenderer/AndroidNativeCanvas

AndroidNativeCanvas

class AndroidNativeCanvas(canvas: Canvas) : KiteCanvas(source)

KiteCanvas backed by android.graphics.Canvas.

This is the right choice on Android when you don't want Compose: pass a Canvas from your custom View's onDraw(Canvas) override straight into the constructor and the renderer paints into it.

Pair with AndroidPdfBitmapRenderer for the "render a PDF page into a Bitmap" use case.

Blend modes require API 29+ (Paint.setBlendMode). The module's minSdk is 29 to match. See kitepdf-native-renderer/module.yaml.

Constructors

AndroidNativeCanvas

constructor(canvas: Canvas)

Properties

resolvesGlyphOutlines

open val resolvesGlyphOutlines: Boolean

Functions

applySoftMask

open override fun applySoftMask(kind: SoftMask.Kind, maskBBox: KiteRectangle, maskCtm: KiteMatrix, render: () -> Unit, renderMask: (KiteCanvas) -> Unit)

open override fun applySoftMask(kind: SoftMask.Kind, maskBBox: KiteRectangle, maskCtm: KiteMatrix, transfer: KiteMaskTransfer?, render: () -> Unit, renderMask: (KiteCanvas) -> Unit)

beginPage

open override fun beginPage(widthPt: Double, heightPt: Double, deviceCtm: KiteMatrix)

beginTransparencyGroup

open override fun beginTransparencyGroup(bbox: KiteRectangle, ctm: KiteMatrix, isolated: Boolean, knockout: Boolean, alpha: Double, blendMode: KiteBlendMode)

A non-isolated group at full alpha in Normal paints straight onto its backdrop, so its blend modes see what lies under it (ISO 32000-1, 11.4.5, #125). Any other group paints into a layer. An Android layer always starts transparent, which is exact for a non-isolated group only when no paint inside blends. In a knockout group (11.4.6) each paint replaces what lies under it inside its shape.

drawGlyphs

open override fun drawGlyphs(glyphs: List<TextGlyph>, fontSize: Double, unitsPerEm: Int, hasOutlines: Boolean, fontSpec: FontSpec, textToDevice: KiteMatrix, color: RgbColor, alpha: Double, blendMode: KiteBlendMode)

drawImage

open override fun drawImage(image: KiteImageData, ctm: KiteMatrix, alpha: Double)

open override fun drawImage(image: KiteImageData, ctm: KiteMatrix, alpha: Double, blendMode: KiteBlendMode)

endPage

open override fun endPage()

endTransparencyGroup

open override fun endTransparencyGroup()

fillPath

open override fun fillPath(path: KitePath, ctm: KiteMatrix, color: RgbColor, evenOdd: Boolean, alpha: Double, blendMode: KiteBlendMode)

fillShading

open override fun fillShading(shading: KiteShading, ctm: KiteMatrix, clipPath: KitePath?, alpha: Double, blendMode: KiteBlendMode)

hostGlyphOutline

open override fun hostGlyphOutline(text: String, fontSpec: FontSpec): KitePath?

The outline of text in the logical font drawGlyphs draws a font without embedded outlines in, at 1000 units per em with y up (#85). Null before API 34, which has no way to walk a path.

popClip

open override fun popClip()

pushClip

open override fun pushClip(path: KitePath, ctm: KiteMatrix, evenOdd: Boolean)

rasterStep

open override fun rasterStep(region: KiteRectangle, ctm: KiteMatrix, step: KiteRasterStep): Boolean

The raster step (#209, #308): its box is region under ctm, which maps to this canvas's pixels, cut to the clip. A render paints into a bitmap of the box. Only a canvas over a known target bitmap reads a backdrop, and only outside every layer. Past STEP_MAX_PIXELS the step works at a lower resolution, and then reads no backdrop.

strokePath

open override fun strokePath(path: KitePath, ctm: KiteMatrix, color: RgbColor, lineWidth: Double, alpha: Double, blendMode: KiteBlendMode, dashArray: List<Double>?, dashPhase: Double, lineCap: Int, lineJoin: Int, miterLimit: Double)