Pixi’VNInterface: ICanvasRenderingContext2D
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:8
Common interface for CanvasRenderingContext2D, OffscreenCanvasRenderingContext2D, and other custom canvas 2D context.
Advanced
Extends
CanvasState.CanvasTransform.CanvasCompositing.CanvasImageSmoothing.CanvasFillStrokeStyles.CanvasShadowStyles.CanvasFilters.CanvasRect.CanvasDrawPath.CanvasText.CanvasDrawImage.CanvasImageData.CanvasPathDrawingStyles.Omit<CanvasTextDrawingStyles,"letterSpacing">.CanvasPath
Extended by
Properties
direction
> direction: CanvasDirection
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7799
Inherited from
Omit.direction
fillStyle
> fillStyle: string | CanvasPattern | CanvasGradient
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7619
Inherited from
CanvasFillStrokeStyles.fillStyle
filter
> filter: string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7634
Inherited from
CanvasFilters.filter
font
> font: string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7801
Inherited from
Omit.font
fontKerning
> fontKerning: CanvasFontKerning
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7803
Inherited from
Omit.fontKerning
fontStretch
> fontStretch: CanvasFontStretch
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7805
Inherited from
Omit.fontStretch
fontVariantCaps
> fontVariantCaps: CanvasFontVariantCaps
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7807
Inherited from
Omit.fontVariantCaps
globalAlpha
> globalAlpha: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7585
Inherited from
CanvasCompositing.globalAlpha
globalCompositeOperation
> globalCompositeOperation: GlobalCompositeOperation
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7587
Inherited from
CanvasCompositing.globalCompositeOperation
imageSmoothingEnabled
> imageSmoothingEnabled: boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7669
Inherited from
CanvasImageSmoothing.imageSmoothingEnabled
imageSmoothingQuality
> imageSmoothingQuality: ImageSmoothingQuality
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7671
Inherited from
CanvasImageSmoothing.imageSmoothingQuality
letterSpacing?
> optional letterSpacing?: string
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:16
sets the horizontal spacing behavior between text characters.
lineCap
> lineCap: CanvasLineCap
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7699
Inherited from
CanvasPathDrawingStyles.lineCap
lineDashOffset
> lineDashOffset: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7701
Inherited from
CanvasPathDrawingStyles.lineDashOffset
lineJoin
> lineJoin: CanvasLineJoin
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7703
Inherited from
CanvasPathDrawingStyles.lineJoin
lineWidth
> lineWidth: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7705
Inherited from
CanvasPathDrawingStyles.lineWidth
miterLimit
> miterLimit: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7707
Inherited from
CanvasPathDrawingStyles.miterLimit
shadowBlur
> shadowBlur: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7768
Inherited from
CanvasShadowStyles.shadowBlur
shadowColor
> shadowColor: string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7770
Inherited from
CanvasShadowStyles.shadowColor
shadowOffsetX
> shadowOffsetX: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7772
Inherited from
CanvasShadowStyles.shadowOffsetX
shadowOffsetY
> shadowOffsetY: number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7774
Inherited from
CanvasShadowStyles.shadowOffsetY
strokeStyle
> strokeStyle: string | CanvasPattern | CanvasGradient
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7621
Inherited from
CanvasFillStrokeStyles.strokeStyle
textAlign
> textAlign: CanvasTextAlign
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7811
Inherited from
Omit.textAlign
textBaseline
> textBaseline: CanvasTextBaseline
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7813
Inherited from
Omit.textBaseline
textLetterSpacing?
> optional textLetterSpacing?: string
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:18
sets the horizontal spacing behavior between text characters.
textRendering
> textRendering: CanvasTextRendering
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7815
Inherited from
Omit.textRendering
wordSpacing
> wordSpacing: string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7817
Inherited from
Omit.wordSpacing
Methods
arc()
> arc(x, y, radius, startAngle, endAngle, counterclockwise?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7676
Parameters
x
number
y
number
radius
number
startAngle
number
endAngle
number
counterclockwise?
boolean
Returns
void
Inherited from
CanvasPath.arc
arcTo()
> arcTo(x1, y1, x2, y2, radius): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7678
Parameters
x1
number
y1
number
x2
number
y2
number
radius
number
Returns
void
Inherited from
CanvasPath.arcTo
beginPath()
> beginPath(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7599
Returns
void
Inherited from
CanvasDrawPath.beginPath
bezierCurveTo()
> bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7680
Parameters
cp1x
number
cp1y
number
cp2x
number
cp2y
number
x
number
y
number
Returns
void
Inherited from
CanvasPath.bezierCurveTo
clearRect()
> clearRect(x, y, w, h): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7735
Parameters
x
number
y
number
w
number
h
number
Returns
void
Inherited from
CanvasRect.clearRect
clip()
Call Signature
> clip(fillRule?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7601
Parameters
fillRule?
CanvasFillRule
Returns
void
Inherited from
CanvasDrawPath.clip
Call Signature
> clip(path, fillRule?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7602
Parameters
path
Path2D
fillRule?
CanvasFillRule
Returns
void
Inherited from
CanvasDrawPath.clip
closePath()
> closePath(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7682
Returns
void
Inherited from
CanvasPath.closePath
createConicGradient()
> createConicGradient(startAngle, x, y): CanvasGradient
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7623
Parameters
startAngle
number
x
number
y
number
Returns
CanvasGradient
Inherited from
CanvasFillStrokeStyles.createConicGradient
createImageData()
Call Signature
> createImageData(sw, sh, settings?): ImageData
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7658
Parameters
sw
number
sh
number
settings?
ImageDataSettings
Returns
ImageData
Inherited from
CanvasImageData.createImageData
Call Signature
> createImageData(imageData): ImageData
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7659
Parameters
imageData
ImageData
Returns
ImageData
Inherited from
CanvasImageData.createImageData
createLinearGradient()
> createLinearGradient(x0, y0, x1, y1): CanvasGradient
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7625
Parameters
x0
number
y0
number
x1
number
y1
number
Returns
CanvasGradient
Inherited from
CanvasFillStrokeStyles.createLinearGradient
createPattern()
> createPattern(image, repetition): CanvasPattern | null
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:10
creates a pattern using the specified image and repetition.
Parameters
image
ICanvas | ImageLike | CanvasImageSource
repetition
string | null
Returns
CanvasPattern | null
Overrides
CanvasFillStrokeStyles.createPattern
createRadialGradient()
> createRadialGradient(x0, y0, r0, x1, y1, r1): CanvasGradient
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7629
Parameters
x0
number
y0
number
r0
number
x1
number
y1
number
r1
number
Returns
CanvasGradient
Inherited from
CanvasFillStrokeStyles.createRadialGradient
drawImage()
Call Signature
> drawImage(image, dx, dy): void
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:12
provides different ways to draw an image onto the canvas
Parameters
image
ICanvas | ImageLike | CanvasImageSource
dx
number
dy
number
Returns
void
Overrides
CanvasDrawImage.drawImage
Call Signature
> drawImage(image, dx, dy, dw, dh): void
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:13
Parameters
image
ICanvas | ImageLike | CanvasImageSource
dx
number
dy
number
dw
number
dh
number
Returns
void
Overrides
CanvasDrawImage.drawImage
Call Signature
> drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh): void
Defined in: node_modules/pixi.js/lib/environment/canvas/ICanvasRenderingContext2D.d.ts:14
Parameters
image
ICanvas | ImageLike | CanvasImageSource
sx
number
sy
number
sw
number
sh
number
dx
number
dy
number
dw
number
dh
number
Returns
void
Overrides
CanvasDrawImage.drawImage
ellipse()
> ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7684
Parameters
x
number
y
number
radiusX
number
radiusY
number
rotation
number
startAngle
number
endAngle
number
counterclockwise?
boolean
Returns
void
Inherited from
CanvasPath.ellipse
fill()
Call Signature
> fill(fillRule?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7604
Parameters
fillRule?
CanvasFillRule
Returns
void
Inherited from
CanvasDrawPath.fill
Call Signature
> fill(path, fillRule?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7605
Parameters
path
Path2D
fillRule?
CanvasFillRule
Returns
void
Inherited from
CanvasDrawPath.fill
fillRect()
> fillRect(x, y, w, h): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7737
Parameters
x
number
y
number
w
number
h
number
Returns
void
Inherited from
CanvasRect.fillRect
fillText()
> fillText(text, x, y, maxWidth?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7790
Parameters
text
string
x
number
y
number
maxWidth?
number
Returns
void
Inherited from
CanvasText.fillText
getImageData()
> getImageData(sx, sy, sw, sh, settings?): ImageData
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7661
Parameters
sx
number
sy
number
sw
number
sh
number
settings?
ImageDataSettings
Returns
ImageData
Inherited from
CanvasImageData.getImageData
getLineDash()
> getLineDash(): number[]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7709
Returns
number[]
Inherited from
CanvasPathDrawingStyles.getLineDash
getTransform()
> getTransform(): DOMMatrix
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7822
Returns
DOMMatrix
Inherited from
CanvasTransform.getTransform
isContextLost()
> isContextLost(): boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7779
Returns
boolean
Inherited from
CanvasState.isContextLost
isPointInPath()
Call Signature
> isPointInPath(x, y, fillRule?): boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7607
Parameters
x
number
y
number
fillRule?
CanvasFillRule
Returns
boolean
Inherited from
CanvasDrawPath.isPointInPath
Call Signature
> isPointInPath(path, x, y, fillRule?): boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7608
Parameters
path
Path2D
x
number
y
number
fillRule?
CanvasFillRule
Returns
boolean
Inherited from
CanvasDrawPath.isPointInPath
isPointInStroke()
Call Signature
> isPointInStroke(x, y): boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7610
Parameters
x
number
y
number
Returns
boolean
Inherited from
CanvasDrawPath.isPointInStroke
Call Signature
> isPointInStroke(path, x, y): boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7611
Parameters
path
Path2D
x
number
y
number
Returns
boolean
Inherited from
CanvasDrawPath.isPointInStroke
lineTo()
> lineTo(x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7686
Parameters
x
number
y
number
Returns
void
Inherited from
CanvasPath.lineTo
measureText()
> measureText(text): TextMetrics
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7792
Parameters
text
string
Returns
TextMetrics
Inherited from
CanvasText.measureText
moveTo()
> moveTo(x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7688
Parameters
x
number
y
number
Returns
void
Inherited from
CanvasPath.moveTo
putImageData()
Call Signature
> putImageData(imageData, dx, dy): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7663
Parameters
imageData
ImageData
dx
number
dy
number
Returns
void
Inherited from
CanvasImageData.putImageData
Call Signature
> putImageData(imageData, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7664
Parameters
imageData
ImageData
dx
number
dy
number
dirtyX
number
dirtyY
number
dirtyWidth
number
dirtyHeight
number
Returns
void
Inherited from
CanvasImageData.putImageData
quadraticCurveTo()
> quadraticCurveTo(cpx, cpy, x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7690
Parameters
cpx
number
cpy
number
x
number
y
number
Returns
void
Inherited from
CanvasPath.quadraticCurveTo
rect()
> rect(x, y, w, h): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7692
Parameters
x
number
y
number
w
number
h
number
Returns
void
Inherited from
CanvasPath.rect
reset()
> reset(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7781
Returns
void
Inherited from
CanvasState.reset
resetTransform()
> resetTransform(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7824
Returns
void
Inherited from
CanvasTransform.resetTransform
restore()
> restore(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7783
Returns
void
Inherited from
CanvasState.restore
rotate()
> rotate(angle): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7826
Parameters
angle
number
Returns
void
Inherited from
CanvasTransform.rotate
roundRect()
Call Signature
> roundRect(x, y, w, h, radii?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7694
Parameters
x
number
y
number
w
number
h
number
radii?
number | DOMPointInit | (number | DOMPointInit)[]
Returns
void
Inherited from
CanvasPath.roundRect
Call Signature
> roundRect(x, y, w, h, radii?): void
Defined in: node_modules/typescript/lib/lib.dom.iterable.d.ts:94
Parameters
x
number
y
number
w
number
h
number
radii?
number | DOMPointInit | Iterable<number | DOMPointInit, any, any>
Returns
void
Inherited from
CanvasPath.roundRect
save()
> save(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7785
Returns
void
Inherited from
CanvasState.save
scale()
> scale(x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7828
Parameters
x
number
y
number
Returns
void
Inherited from
CanvasTransform.scale
setLineDash()
Call Signature
> setLineDash(segments): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7711
Parameters
segments
number[]
Returns
void
Inherited from
CanvasPathDrawingStyles.setLineDash
Call Signature
> setLineDash(segments): void
Defined in: node_modules/typescript/lib/lib.dom.iterable.d.ts:99
Parameters
segments
Iterable<number>
Returns
void
Inherited from
CanvasPathDrawingStyles.setLineDash
setTransform()
Call Signature
> setTransform(a, b, c, d, e, f): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7830
Parameters
a
number
b
number
c
number
d
number
e
number
f
number
Returns
void
Inherited from
CanvasTransform.setTransform
Call Signature
> setTransform(transform?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7831
Parameters
transform?
DOMMatrix2DInit
Returns
void
Inherited from
CanvasTransform.setTransform
stroke()
Call Signature
> stroke(): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7613
Returns
void
Inherited from
CanvasDrawPath.stroke
Call Signature
> stroke(path): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7614
Parameters
path
Path2D
Returns
void
Inherited from
CanvasDrawPath.stroke
strokeRect()
> strokeRect(x, y, w, h): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7739
Parameters
x
number
y
number
w
number
h
number
Returns
void
Inherited from
CanvasRect.strokeRect
strokeText()
> strokeText(text, x, y, maxWidth?): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7794
Parameters
text
string
x
number
y
number
maxWidth?
number
Returns
void
Inherited from
CanvasText.strokeText
transform()
> transform(a, b, c, d, e, f): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7833
Parameters
a
number
b
number
c
number
d
number
e
number
f
number
Returns
void
Inherited from
CanvasTransform.transform
translate()
> translate(x, y): void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:7835
Parameters
x
number
y
number
Returns
void
Inherited from
CanvasTransform.translate