kitepdf/io.github.yuroyami.kitepdf.render/PdfShading/Axial

Axial

data class Axial(val colorSpace: ColorSpace, val background: RgbColor?, val bbox: Rectangle?, val coords: DoubleArray, val domain: DoubleArray, val function: PdfFunction, val extendStart: Boolean, val extendEnd: Boolean) : PdfShading

Type 2 axial shading. Linear gradient between (x0, y0) and (x1, y1) with t running across domain. function supplies a colour per t value; we sample it at a fixed number of stops and hand those to the backend.

Constructors

Axial

constructor(colorSpace: ColorSpace, background: RgbColor?, bbox: Rectangle?, coords: DoubleArray, domain: DoubleArray, function: PdfFunction, extendStart: Boolean, extendEnd: Boolean)

Properties

background

open override val background: RgbColor?

Optional /Background colour — used for regions outside the shading domain when Extend is false on the relevant side. Per spec the background is in colorSpace; we eager-convert to RGB.

bbox

open override val bbox: Rectangle?

Optional clipping rectangle (/BBox) in shading-space.

colorSpace

open override val colorSpace: ColorSpace

The shading's colour space (DeviceGray / DeviceRGB / DeviceCMYK / Indexed).

coords

val coords: DoubleArray

x0, y0, x1, y1 in shading-space.

domain

val domain: DoubleArray

t0, t1 — domain of function.

extendEnd

val extendEnd: Boolean

extendStart

val extendStart: Boolean

Extend the gradient beyond t0 / t1 with the endpoint colours.

function

val function: PdfFunction

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

sampleStops

fun PdfShading.sampleStops(count: Int = 32): GradientStops?

Sample a PdfShading.Axial or PdfShading.Radial at evenly-spaced stops between domain[0] and domain[1]. Returns parallel t and RGB arrays the backend uses to build a gradient brush.