Canvas

class Canvas : Closable

Provides 2D (two dimensional) graphics drawing functionality that is applied to a Surface.

class Canvas : Closable

Types

Companion

common

object Companion

Functions

changeDash

common

fun changeDash(dashes: DoubleArray, offset: Double)

Changes the dash pattern to be used by stroke.

fun changeDash(dashes: DoubleArray, offset: Double)

changeSourceRgb

common

fun changeSourceRgb(red: Double, green: Double, blue: Double)

Changes the source pattern to an opaque color.

fun changeSourceRgb(red: Double, green: Double, blue: Double)

changeSourceRgba

common

fun changeSourceRgba(red: Double, green: Double, blue: Double, alpha: Double)

Sets the source pattern to a translucent color.

fun changeSourceRgba(red: Double, green: Double, blue: Double, alpha: Double)

open override fun close()

abstract fun close()

copyPage

common

fun copyPage()

Emits the current page for backends that support multiple pages, but doesn't clear it so the contents of the current page will be retained for the next page too.

fun copyPage()

fetchDash

common

fun fetchDash(): Pair<DoubleArray, Double>

Gets the current dash array.

fun fetchDash(): Pair<DoubleArray, Double>

fill

common

fun fill()

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled).

fun fill()

fillExtents

common

fun fillExtents(): FillExtentsResult

Computes a bounding box in user coordinates covering the area that would be affected (the "inked" area), by a fill operation given the current path and fill parameters.

fun fillExtents(): FillExtentsResult

fillPreserve

common

fun fillPreserve()

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled).

fun fillPreserve()

inFill

common

fun inFill(xPos: Double, yPos: Double): Boolean

Tests whether the given point is inside the area that would be affected by a fill operation given the current path and filling parameters.

fun inFill(xPos: Double, yPos: Double): Boolean

inStroke

common

fun inStroke(xPos: Double, yPos: Double): Boolean

Tests whether the given point is inside the area that would be affected by a stroke operation given the current path and stroking parameters.

fun inStroke(xPos: Double, yPos: Double): Boolean

showPage

common

fun showPage()

Emits and clears the current page for backends that support multiple pages.

fun showPage()

statusCode

common

fun statusCode(): UInt

Provides the status code for this Canvas.

fun statusCode(): UInt

stroke

common

fun stroke()

A drawing operator that strokes the current path according to the current line width, line join, line cap, and dash settings.

fun stroke()

strokeExtents

common

fun strokeExtents(): StrokeExtentsResult

Computes a bounding box in user coordinates covering the area that would be affected, (the inked area), by a stroke operation given the current path and stroke parameters.

fun strokeExtents(): StrokeExtentsResult