Git Product home page Git Product logo

canvas-context's Introduction

canvas-context stable

npm version styled with prettier

Create a RenderingContext (2d, webgl, webgl2, bitmaprenderer), optionally offscreen for possible use in a Worker.

See the demo and its source for an example with Worker implementation.

Installation

npm install canvas-context

NPM

Usage

const createCanvasContext = require("canvas-context");

const { context, canvas } = createCanvasContext("2d", {
	width: 100,
	height: 100,
	offscreen: true
});

API

createCanvasContext(contextType, options): { context: RenderingContext, canvas: HTMLCanvasElement }

type ContextType =
	| "2d"
	| "webgl"
	| "experimental-webgl"
	| "webgl2"
	| "bitmaprenderer";
Option Type Default Description
contextType ContextType "2d" Context identifier defining the drawing context associated to the canvas
options.canvas HTMLCanvasElement? An optional canvas. Necessary when window === "undefined" (eg. Node or Worker context)
options.width number? 300 Set canvas.width (should be an integer >= 0)
options.height number? 150 Set canvas.height (should be an integer >= 0)
options.offscreen boolean? false Create an OffscreenCanvas or transferControlToOffscreen() if options.canvas
options.worker boolean? false Try to get an OffscreenCanvas and return only the canvas so it can be transferred in a Worker

License

MIT. See license file.

canvas-context's People

Contributors

dmnsgn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.