npm version stability-stable npm minzipped size dependencies types Conventional Commits styled with prettier linted with eslint license
Create a RenderingContext (2d, webgl, webgl2, bitmaprenderer, webgpu), optionally offscreen for possible use in a Worker.
See the example and its source with a Worker implementation.
npm install canvas-context
import createCanvasContext from "canvas-context"; const { context, canvas } = createCanvasContext("2d", { width: 100, height: 100, offscreen: true, });
- ContextType :
"2d"|"webgl"|"experimental-webgl"|"webgl2"|"webgl2-compute"|"bitmaprenderer"|"gpupresent"|"webgpu" A DOMString containing the context identifier defining the drawing context associated to the canvas.
- CanvasContextOptions :
object Options for canvas creation. All optional.
- CanvasContextReturnValue :
object
createCanvasContext([contextType], [options]) ⇒ CanvasContextReturnValue ⏏
Create a RenderingContext (2d, webgl, webgl2, bitmaprenderer, webgpu), optionally offscreen for possible use in a Worker.
Kind: Exported function
| Param | Type | Default |
|---|---|---|
| [contextType] | ContextType |
"2d" |
| [options] | CanvasContextOptions |
{} |
ContextType : "2d" | "webgl" | "experimental-webgl" | "webgl2" | "webgl2-compute" | "bitmaprenderer" | "gpupresent" | "webgpu"
A DOMString containing the context identifier defining the drawing context associated to the canvas.
Kind: global typedef
Options for canvas creation. All optional.
Kind: global typedef Properties
| Name | Type | Default | Description |
|---|---|---|---|
| [width] | number |
300 |
Request an initial canvas width. |
| [height] | number |
150 |
Request an initial canvas height. |
| [offscreen] | boolean |
false |
Request an offscreen canvas. |
| [worker] | boolean |
false |
Handle use in a worker. |
| [contextAttributes] | CanvasRenderingContext2DSettings | WebGLContextAttributes |
{} |
Attributes to be passed to getContext. |
| [canvas] | HTMLCanvasElement |
Canvas element to use. |
Kind: global typedef Properties
| Name | Type |
|---|---|
| canvas | HTMLCanvasElement | OffscreenCanvas |
| context | RenderingContext |
MIT. See license file.