shader-canvas

A rendering engine where you can write WebGL 2.0 shaders using custom low-level tags.

• For documentation check the official site.

• For examples check the examples folder.

• For code distribution deno.land is being used.

Current version: v1.0.0

Developer notes

The main file and code flow entry point is shader_canvas.ts.

If you are interested in contributing this is a cool place to start reading the code.

Make commands

This project uses make to do the build automation and developer environment.

The Makefile has the following main actions:

• make serve

Use this command to start a development server at localhost:8000

• make stop

Use this command to stop the development server

• make docs/documentation.md

Use this command to generate the documentation markdown file which is then used to produce the official docs

• make build/shader_canvas.min.js

Use this command to generate the final production file at build/shader_canvas.min.js.

Running tests

Tests run in the browser, mocha and chaijs are being used to test the usage of the Shader Canvas components.

To run the tests, start the local development server by running make serve and then access http://localhost:8000/tests/test.html.

Tests are located in the tests/ folder.