kitepdf/io.github.yuroyami.kitepdf.render/GraphicsState

GraphicsState

data class GraphicsState(val ctm: Matrix = Matrix.IDENTITY, val strokeColor: RgbColor = RgbColor.BLACK, val fillColor: RgbColor = RgbColor.BLACK, val lineWidth: Double = 1.0, val text: TextState = TextState(), val fillColorSpace: ColorSpace = ColorSpace.DeviceGray, val strokeColorSpace: ColorSpace = ColorSpace.DeviceGray, val fillAlpha: Double = 1.0, val strokeAlpha: Double = 1.0, val blendMode: BlendMode = BlendMode.Normal, val softMask: SoftMask? = null, val fillPattern: PdfPattern? = null, val strokePattern: PdfPattern? = null, val dashArray: List<Double>? = null, val dashPhase: Double = 0.0)

Graphics state (ISO 32000-1 §8.4).

Every PDF content stream runs inside a stack of graphics states. q pushes a copy; Q pops back. cm, color setters, font setters etc. mutate the top of the stack. We model this with an immutable GraphicsState data class and a stack on the side (see GraphicsStack) — easier to reason about than a mutable struct, and the cost is a small allocation per q.

Text state (Tm, Tlm, font, size, spacing) is tracked separately on TextState and lives only inside BT…ET blocks.

Constructors

GraphicsState

constructor(ctm: Matrix = Matrix.IDENTITY, strokeColor: RgbColor = RgbColor.BLACK, fillColor: RgbColor = RgbColor.BLACK, lineWidth: Double = 1.0, text: TextState = TextState(), fillColorSpace: ColorSpace = ColorSpace.DeviceGray, strokeColorSpace: ColorSpace = ColorSpace.DeviceGray, fillAlpha: Double = 1.0, strokeAlpha: Double = 1.0, blendMode: BlendMode = BlendMode.Normal, softMask: SoftMask? = null, fillPattern: PdfPattern? = null, strokePattern: PdfPattern? = null, dashArray: List<Double>? = null, dashPhase: Double = 0.0)

Properties

blendMode

val blendMode: BlendMode

Blend mode applied to paints (ExtGState /BM).

ctm

val ctm: Matrix

dashArray

val dashArray: List<Double>? = null

Dash pattern (d operator): on/off lengths in user-space units; null/empty = solid.

dashPhase

val dashPhase: Double = 0.0

Dash phase offset (d operator), user-space units.

fillAlpha

val fillAlpha: Double = 1.0

Per-pixel alpha multiplier for fills (ExtGState /ca), 0..1.

fillColor

val fillColor: RgbColor

fillColorSpace

val fillColorSpace: ColorSpace

Current non-stroke colour space (cs operator).

fillPattern

val fillPattern: PdfPattern? = null

Active fill pattern — set by scn when the fill colour-space is /Pattern. When non-null, fillColor is ignored and paint operators route through the canvas's gradient/tile path. Cleared by any plain colour setter (g, rg, k, cs, sc).

lineWidth

val lineWidth: Double = 1.0

softMask

val softMask: SoftMask? = null

Active soft mask (ExtGState /SMask); null when none.

strokeAlpha

val strokeAlpha: Double = 1.0

Per-pixel alpha multiplier for strokes (ExtGState /CA), 0..1.

strokeColor

val strokeColor: RgbColor

strokeColorSpace

val strokeColorSpace: ColorSpace

Current stroke colour space (CS operator).

strokePattern

val strokePattern: PdfPattern? = null

Active stroke pattern — same semantics as fillPattern for SCN.

text

val text: TextState

Functions

applyExtGState

fun GraphicsState.applyExtGState(ext: ExtGState): GraphicsState

Merge the non-null fields of ext into this state. Spec semantics for gs <name>: only entries present in the ExtGState override; everything else passes through.