Interface: CanvasRenderingContext2D

Defined in: types/desktop-engine.d.ts:1059

2D rendering context (Canvas2DRenderingContext); largely the same interface as on the web; Path2D isn't supported

Properties

canvas

readonly canvas: Canvas | null;

Defined in: types/desktop-engine.d.ts:1061

The owning canvas

fillStyle

fillStyle: 
  | string
  | CanvasGradient
  | CanvasPattern;

Defined in: types/desktop-engine.d.ts:1077

Fill style. Colors: #rgb, #rgba, #rrggbb, #rrggbbaa, rgb()/rgba() and hsl()/hsla() with commas or spaces (rgb(255 0 0 / 50%)), or a CSS color name; invalid colors are ignored, like on the web. Colors read back as an rgba(r,g,b,a) string

font

font: string;

Defined in: types/desktop-engine.d.ts:1098

Font, the CSS font shorthand: [italic] [weight] size[/line-height] family[, family…], such as "600 14px system-ui" or "bold 16px 'Avenir Next', Helvetica"; defaults to 10px Helvetica.

weight: normal, bold or 1–1000 (400 normal, 700 bold)
size: px or pt; the line height is ignored
family: the first installed one of the list. system-ui (also -apple-system, BlinkMacSystemFont, ui-sans-serif) is the system font, San Francisco with PingFang for Chinese; ui-rounded, ui-monospace and ui-serif are its rounded, monospaced and serif (New York) designs; sans-serif, serif and monospace are Helvetica, Times and Courier. Without an installed family the font keeps its family

An invalid value is ignored. Reads back as [italic ][weight ]<size>px <family>, e.g. 600 14px system-ui

globalAlpha

globalAlpha: number;

Defined in: types/desktop-engine.d.ts:1081

Global alpha

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation;

Defined in: types/desktop-engine.d.ts:1063

Compositing mode

imageSmoothingEnabled

imageSmoothingEnabled: boolean;

Defined in: types/desktop-engine.d.ts:1100

Whether images are smoothed when scaled

lineCap

lineCap: CanvasLineCap;

Defined in: types/desktop-engine.d.ts:1065

Line cap

lineDashOffset

lineDashOffset: number;

Defined in: types/desktop-engine.d.ts:1102

Line dash offset

lineJoin

lineJoin: CanvasLineJoin;

Defined in: types/desktop-engine.d.ts:1067

Line join

lineWidth

lineWidth: number;

Defined in: types/desktop-engine.d.ts:1083

Line width

miterLimit

miterLimit: number;

Defined in: types/desktop-engine.d.ts:1085

Miter limit

shadowBlur

shadowBlur: number;

Defined in: types/desktop-engine.d.ts:1106

Shadow blur

shadowColor

shadowColor: string;

Defined in: types/desktop-engine.d.ts:1104

Shadow color, as for fillStyle (reads back as an rgba() string)

shadowOffsetX

shadowOffsetX: number;

Defined in: types/desktop-engine.d.ts:1108

Shadow x offset

shadowOffsetY

shadowOffsetY: number;

Defined in: types/desktop-engine.d.ts:1110

Shadow y offset

strokeStyle

strokeStyle: 
  | string
  | CanvasGradient
  | CanvasPattern;

Defined in: types/desktop-engine.d.ts:1079

Stroke style, colors as for fillStyle; colors read back as an rgba(r,g,b,a) string

textAlign

textAlign: CanvasTextAlign;

Defined in: types/desktop-engine.d.ts:1069

Text alignment

textBaseline

textBaseline: CanvasTextBaseline;

Defined in: types/desktop-engine.d.ts:1071

Text baseline

Methods

arc()

arc(
   x, 
   y, 
   radius, 
   startAngle, 
   endAngle, 
   counterclockwise?
): void;

Defined in: types/desktop-engine.d.ts:1177

Arc

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`radius`	`number`
`startAngle`	`number`
`endAngle`	`number`
`counterclockwise?`	`boolean`

Returns

void

arcTo()

arcTo(
   x1, 
   y1, 
   x2, 
   y2, 
   radius
): void;

Defined in: types/desktop-engine.d.ts:1175

Arc tangent to two lines

Parameters

Parameter	Type
`x1`	`number`
`y1`	`number`
`x2`	`number`
`y2`	`number`
`radius`	`number`

Returns

void

beginPath()

beginPath(): void;

Defined in: types/desktop-engine.d.ts:1157

Begins a path

Returns

void

bezierCurveTo()

bezierCurveTo(
   cp1x, 
   cp1y, 
   cp2x, 
   cp2y, 
   x, 
   y
): void;

Defined in: types/desktop-engine.d.ts:1171

Cubic Bézier curve

Parameters

Parameter	Type
`cp1x`	`number`
`cp1y`	`number`
`cp2x`	`number`
`cp2y`	`number`
`x`	`number`
`y`	`number`

Returns

void

clearRect()

clearRect(
   x, 
   y, 
   w, 
   h
): void;

Defined in: types/desktop-engine.d.ts:1143

Clears a rectangle

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`

Returns

void

clip()

clip(fillRule?): void;

Defined in: types/desktop-engine.d.ts:1185

Clips to the current path

Parameters

Parameter	Type
`fillRule?`	`CanvasFillRule`

Returns

void

closePath()

closePath(): void;

Defined in: types/desktop-engine.d.ts:1159

Closes the path

Returns

void

createImageData()

createImageData(
   sw, 
   sh, 
   data?
): ImageData;

Defined in: types/desktop-engine.d.ts:1147

Creates pixel data, optionally initialized from a Uint8ClampedArray (non-standard third argument)

Parameters

Parameter	Type
`sw`	`number`
`sh`	`number`
`data?`	`Uint8ClampedArray`<`ArrayBufferLike`>

Returns

ImageData

createLinearGradient()

createLinearGradient(
   x0, 
   y0, 
   x1, 
   y1
): CanvasGradient;

Defined in: types/desktop-engine.d.ts:1151

Creates a linear gradient

Parameters

Parameter	Type
`x0`	`number`
`y0`	`number`
`x1`	`number`
`y1`	`number`

Returns

CanvasGradient

createPattern()

createPattern(image, repetition?): CanvasPattern | undefined;

Defined in: types/desktop-engine.d.ts:1155

Creates a pattern; defaults to repeat

Parameters

Parameter	Type
`image`	`CanvasDrawable`
`repetition?`	`CanvasPatternRepetition`

Returns

CanvasPattern | undefined

createRadialGradient()

createRadialGradient(
   x0, 
   y0, 
   r0, 
   x1, 
   y1, 
   r1
): CanvasGradient;

Defined in: types/desktop-engine.d.ts:1153

Creates a radial gradient

Parameters

Parameter	Type
`x0`	`number`
`y0`	`number`
`r0`	`number`
`x1`	`number`
`y1`	`number`
`r1`	`number`

Returns

CanvasGradient

drawImage()

Call Signature

drawImage(
   image, 
   dx, 
   dy
): void;

Defined in: types/desktop-engine.d.ts:1133

Draws an image at (dx, dy)

Parameters

Parameter	Type
`image`	`CanvasDrawable`
`dx`	`number`
`dy`	`number`

Returns

void

Call Signature

drawImage(
   image, 
   dx, 
   dy, 
   dw, 
   dh
): void;

Defined in: types/desktop-engine.d.ts:1135

Draws an image into the given rectangle

Parameters

Parameter	Type
`image`	`CanvasDrawable`
`dx`	`number`
`dy`	`number`
`dw`	`number`
`dh`	`number`

Returns

void

Call Signature

drawImage(
   image, 
   sx, 
   sy, 
   sw, 
   sh, 
   dx, 
   dy, 
   dw, 
   dh
): void;

Defined in: types/desktop-engine.d.ts:1137

Crops the source rectangle and draws it into the destination rectangle

Parameters

Parameter	Type
`image`	`CanvasDrawable`
`sx`	`number`
`sy`	`number`
`sw`	`number`
`sh`	`number`
`dx`	`number`
`dy`	`number`
`dw`	`number`
`dh`	`number`

Returns

void

fill()

fill(fillRule?): void;

Defined in: types/desktop-engine.d.ts:1161

Fills the path

Parameters

Parameter	Type
`fillRule?`	`CanvasFillRule`

Returns

void

fillRect()

fillRect(
   x, 
   y, 
   w, 
   h
): void;

Defined in: types/desktop-engine.d.ts:1139

Fills a rectangle

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`

Returns

void

fillText()

fillText(
   text, 
   x, 
   y, 
   maxWidth?
): void;

Defined in: types/desktop-engine.d.ts:1181

Fills text

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth?`	`number`

Returns

void

getImageData()

getImageData(
   sx, 
   sy, 
   sw, 
   sh
): ImageData;

Defined in: types/desktop-engine.d.ts:1145

Reads pixels

Parameters

Parameter	Type
`sx`	`number`
`sy`	`number`
`sw`	`number`
`sh`	`number`

Returns

ImageData

getLineDash()

getLineDash(): number[];

Defined in: types/desktop-engine.d.ts:1189

Gets the line dash pattern

Returns

number[]

isContextLost()

isContextLost(): boolean;

Defined in: types/desktop-engine.d.ts:1113

Whether the context was lost: the GPU stopped its work (see the canvas' contextlost event). It isn't restored

Returns

boolean

isPointInPath()

isPointInPath(...args): undefined;

Defined in: types/desktop-engine.d.ts:1193

Not implemented; calling it only logs a warning

Parameters

Parameter	Type
...`args`	`unknown`[]

Returns

undefined

lineTo()

lineTo(x, y): void;

Defined in: types/desktop-engine.d.ts:1167

Draws a straight line

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

measureText()

measureText(text): TextMetrics;

Defined in: types/desktop-engine.d.ts:1179

Measures text

Parameters

Parameter	Type
`text`	`string`

Returns

TextMetrics

moveTo()

moveTo(x, y): void;

Defined in: types/desktop-engine.d.ts:1165

Moves the pen

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

putImageData()

putImageData(
   imageData, 
   dx, 
   dy
): void;

Defined in: types/desktop-engine.d.ts:1149

Writes pixels

Parameters

Parameter	Type
`imageData`	`ImageData`
`dx`	`number`
`dy`	`number`

Returns

void

quadraticCurveTo()

quadraticCurveTo(
   cpx, 
   cpy, 
   x, 
   y
): void;

Defined in: types/desktop-engine.d.ts:1173

Quadratic Bézier curve

Parameters

Parameter	Type
`cpx`	`number`
`cpy`	`number`
`x`	`number`
`y`	`number`

Returns

void

rect()

rect(
   x, 
   y, 
   w, 
   h
): void;

Defined in: types/desktop-engine.d.ts:1169

Adds a rectangle to the path

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`

Returns

void

resetClip()

resetClip(): void;

Defined in: types/desktop-engine.d.ts:1187

Clears the clip (non-standard)

Returns

void

resetCurrentState()

resetCurrentState(): void;

Defined in: types/desktop-engine.d.ts:1119

Resets the current state (non-standard)

Returns

void

resetTransform()

resetTransform(): void;

Defined in: types/desktop-engine.d.ts:1131

Resets the transform matrix to the identity

Returns

void

restore()

restore(): void;

Defined in: types/desktop-engine.d.ts:1117

Restores the state

Returns

void

rotate()

rotate(angle): void;

Defined in: types/desktop-engine.d.ts:1121

Rotates (radians)

Parameters

Parameter	Type
`angle`	`number`

Returns

void

save()

save(): void;

Defined in: types/desktop-engine.d.ts:1115

Saves the state

Returns

void

scale()

scale(x, y): void;

Defined in: types/desktop-engine.d.ts:1125

Scales

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

setLineDash()

setLineDash(segments): void;

Defined in: types/desktop-engine.d.ts:1191

Sets the line dash pattern

Parameters

Parameter	Type
`segments`	(`string` \| `number`)[]

Returns

void

setTransform()

setTransform(
   a, 
   b, 
   c, 
   d, 
   e, 
   f
): void;

Defined in: types/desktop-engine.d.ts:1129

Sets the transform matrix

Parameters

Parameter	Type
`a`	`number`
`b`	`number`
`c`	`number`
`d`	`number`
`e`	`number`
`f`	`number`

Returns

void

stroke()

stroke(): void;

Defined in: types/desktop-engine.d.ts:1163

Strokes the path

Returns

void

strokeRect()

strokeRect(
   x, 
   y, 
   w, 
   h
): void;

Defined in: types/desktop-engine.d.ts:1141

Strokes a rectangle

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`

Returns

void

strokeText()

strokeText(
   text, 
   x, 
   y, 
   maxWidth?
): void;

Defined in: types/desktop-engine.d.ts:1183

Strokes text

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth?`	`number`

Returns

void

transform()

transform(
   a, 
   b, 
   c, 
   d, 
   e, 
   f
): void;

Defined in: types/desktop-engine.d.ts:1127

Multiplies the current transform matrix

Parameters

Parameter	Type
`a`	`number`
`b`	`number`
`c`	`number`
`d`	`number`
`e`	`number`
`f`	`number`

Returns

void

translate()

translate(x, y): void;

Defined in: types/desktop-engine.d.ts:1123

Translates

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

DesktopEngine

Interfaces

Type Aliases

Interface: CanvasRenderingContext2D ​

Properties ​

canvas ​

fillStyle ​

font ​

globalAlpha ​

globalCompositeOperation ​

imageSmoothingEnabled ​

lineCap ​

lineDashOffset ​

lineJoin ​

lineWidth ​

miterLimit ​

shadowBlur ​

shadowColor ​

shadowOffsetX ​

shadowOffsetY ​

strokeStyle ​

textAlign ​

textBaseline ​

Methods ​

arc() ​

Parameters ​

Returns ​

arcTo() ​

Parameters ​

Returns ​

beginPath() ​

Returns ​

bezierCurveTo() ​

Parameters ​

Returns ​

clearRect() ​

Parameters ​

Returns ​

clip() ​

Parameters ​

Returns ​

closePath() ​

Returns ​

createImageData() ​

Parameters ​

Returns ​

createLinearGradient() ​

Parameters ​

Returns ​

createPattern() ​

Parameters ​

Returns ​

createRadialGradient() ​

Parameters ​

Returns ​

drawImage() ​

Call Signature ​

Parameters ​

Returns ​

Call Signature ​

Parameters ​

Returns ​

Call Signature ​

Parameters ​

Returns ​

fill() ​

Parameters ​

Returns ​

fillRect() ​

Parameters ​

Returns ​

fillText() ​

Parameters ​

Returns ​

getImageData() ​

Parameters ​

Returns ​

getLineDash() ​

Returns ​

isContextLost() ​

Interface: CanvasRenderingContext2D

Properties

canvas

fillStyle

font

globalAlpha

globalCompositeOperation

imageSmoothingEnabled

lineCap

lineDashOffset

lineJoin

lineWidth

miterLimit

shadowBlur

shadowColor

shadowOffsetX

shadowOffsetY

strokeStyle

textAlign

textBaseline

Methods

arc()

Parameters

Returns

arcTo()

Parameters

Returns

beginPath()

Returns

bezierCurveTo()

Parameters

Returns

clearRect()

Parameters

Returns

clip()

Parameters

Returns

closePath()

Returns

createImageData()

Parameters

Returns

createLinearGradient()

Parameters

Returns

createPattern()

Parameters

Returns

createRadialGradient()

Parameters

Returns

drawImage()

Call Signature

Parameters

Returns

Call Signature

Parameters

Returns

Call Signature

Parameters

Returns

fill()

Parameters

Returns

fillRect()

Parameters

Returns

fillText()

Parameters

Returns

getImageData()

Parameters

Returns

getLineDash()

Returns

isContextLost()

Returns

isPointInPath()

Parameters