JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9
  • Score
    100M100P100Q37894F
  • License MIT

A javascript utility library that helps setup and manage a 2d or 3d canvas

Package Exports

  • @ion-cloud/easel
  • @ion-cloud/easel/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ion-cloud/easel) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

easel

A javascript utility library that helps setup and manage a 2d canvas

Setup

Getting started is as easy as npm i @ion-cloud/easel or npm i @ion-cloud/core. After that you're ready to start importing it into your code. The actual setup is really just one line of code. Here we set easel up and draw text in the center of the screen.

WebGL context

import {EaselWebGL} from '@ion-cloud/easel';

const easel = new EaselWebGL(); //this initializes the library and creates easel

// now lets draw a red rectangle centered on the canvas
// coordinate space is normalized between 0 & 1
// color (c) is an rgba array
easel.fillRect({x: 0.25, y: 0.25, w: 0.5, h: 0.5, c: [1.0, 0.0, 0.0, 1.0]})

Standard 2d context

import {Easel} from 'ion-cloud';

const easel = new Easel(); //this initializes the library and creates easel

// now lets draw something on the canvas
easel.ctx.textAlign='center';
easel.ctx.fillStyle='#f00';
easel.ctx.fillText('This text is in the center of the screen.',easel.viewport.w/2,easel.viewport.h/2);

If you want to run code every time the window is resized you can attribute it to the config function.

easel.config = ()=>{

  // inside this function we'll have an updated value for the viewport
  console.log(easel.viewport);
};

It's common in games to have a draw loop for things like animations. Easel provides a simple way of accomplishing this.

easel.onDraw = function main(){
  // draw stuff in here
  requestAnimationFrame(main); //use browser function to acquire best time to loop
};
easel.redraw(); //initiate a draw causing the main loop.