Class CanvasContext

The CanvasContext provides static access to information and methods for the running p5.js sketch canvas.

Index

Constructors

Accessors

defaultStroke isWebGL lockedCanvas

Methods

buildCanvas lockCanvas resizeCanvas unlockCanvas updateAspectRatio updateResolution

Constructors

constructor

new CanvasContext(): CanvasContext
Returns CanvasContext

Accessors

`Static`defaultStroke

get defaultStroke(): number
The default stroke of the sketch. Equivalent to a stroke of 1 in a 500x500 sketch.

Returns number
- Defined in sketch/canvas/canvas-context.ts:127

`Static`isWebGL

get isWebGL(): boolean
Is the canvas rendering mode set to WebGL?

Returns boolean
- Defined in sketch/canvas/canvas-context.ts:112

`Static`lockedCanvas

get lockedCanvas(): boolean
When true, buildCanvas will not create a new canvas.

Returns boolean
- Defined in sketch/canvas/canvas-context.ts:119

Methods

`Static`buildCanvas

buildCanvas(aspectRatio, resolution, canvasType?, lockCanvas?): void
Build a p5 canvas with the given aspect ratio, resolution, and canvas type. If lockedCanvas is true, no canvas will be built.
Parameters
- aspectRatio: AspectRatio
- resolution: number
- OptionalcanvasType: string
  Can be WEBGL ("webgl") or P2D ("p2d").
- OptionallockCanvas: boolean
  When true, the canvas will be locked after it has been created.
Returns void
- Defined in sketch/canvas/canvas-context.ts:81

`Static`lockCanvas

lockCanvas(): void
Locks the canvas. After this is called, buildCanvas will not create a new canvas.

Returns void
- Defined in sketch/canvas/canvas-context.ts:136

`Static`resizeCanvas

resizeCanvas(): void
Resizes the canvas and decorates the canvas with the appropriate updated attributes.

Returns void
- Defined in sketch/canvas/canvas-context.ts:151

`Static`unlockCanvas

unlockCanvas(): void
Unlocks the canvas. After this is called, buildCanvas will create a new canvas.

Returns void
- Defined in sketch/canvas/canvas-context.ts:143

`Static`updateAspectRatio

updateAspectRatio(aspectRatio): void
Update the current aspect ratio of the canvas to the given aspect ratio. This method will resize the canvas and decorate it with the appropriate updated attributes.
Parameters
- aspectRatio: AspectRatio
Returns void
- Defined in sketch/canvas/canvas-context.ts:167

`Static`updateResolution

updateResolution(resolution): void
Update the current resolution of the canvas to the given resolution. This method will resize the canvas and decorate it with the appropriate updated attributes.
Parameters
- resolution: number
Returns void
- Defined in sketch/canvas/canvas-context.ts:185