regl

Functional WebGL

WebGL3D
regl-project/reglregl

README

  👑

  regl

  Fast functional WebGL

  NPM Version
  Build Status
  File Size
  Downloads
  Standard

      Docs
 |
      Chat
 |
      Download
 |
      Minified


Example


regl simplifies WebGL programming by removing as much shared state as it can get away with.  To do this, it replaces the WebGL API with two fundamental abstractions, resources and commands:

A resource is a handle to a GPU resident object, like a texture, FBO or buffer.
A command is a complete representation of the WebGL state required to perform some draw call.

To define a command you specify a mixture of static and dynamic data for the object. Once this is done, regl takes this description and then compiles it into optimized JavaScript code.  For example, here is a simple regl program to draw a triangle:

  1. ``` js
  2. // Calling the regl module with no arguments creates a full screen canvas and
  3. // WebGL context, and then uses this context to initialize a new REGL instance
  4. const regl = require('regl')()

  6. // Calling regl() creates a new partially evaluated draw command
  7. const drawTriangle = regl({

  9.   // Shaders in regl are just strings.  You can use glslify or whatever you want
  10.   // to define them.  No need to manually create shader objects.
  11.   frag: `
  12.     precision mediump float;
  13.     uniform vec4 color;
  14.     void main() {
  15.       gl_FragColor = color;
  16.     }`,

  18.   vert: `
  19.     precision mediump float;
  20.     attribute vec2 position;
  21.     void main() {
  22.       gl_Position = vec4(position, 0, 1);
  23.     }`,

  25.   // Here we define the vertex attributes for the above shader
  26.   attributes: {
  27.     // regl.buffer creates a new array buffer object
  28.     position: regl.buffer([
  29.       [-2, -2],   // no need to flatten nested arrays, regl automatically
  30.       [4, -2],    // unrolls them into a typedarray (default Float32)
  31.       [4,  4]
  32.     ])
  33.     // regl automatically infers sane defaults for the vertex attribute pointers
  34.   },

  36.   uniforms: {
  37.     // This defines the color of the triangle to be a dynamic variable
  38.     color: regl.prop('color')
  39.   },

  41.   // This tells regl the number of vertices to draw in this command
  42.   count: 3
  43. })

  45. // regl.frame() wraps requestAnimationFrame and also handles viewport changes
  46. regl.frame(({time}) => {
  47.   // clear contents of the drawing buffer
  48.   regl.clear({
  49.     color: [0, 0, 0, 0],
  50.     depth: 1
  51.   })

  53.   // draw a triangle using the command defined above
  54.   drawTriangle({
  55.     color: [
  56.       Math.cos(time * 0.001),
  57.       Math.sin(time * 0.0008),
  58.       Math.cos(time * 0.003),
  59.       1
  60.     ]
  61.   })
  62. })
  63. ```

See this example live

More examples


Check out the gallery. The source code of all the gallery examples can be found here.

Setup


regl has no dependencies, so setting it up is pretty easy.  There are 3 basic ways to do this:

Live editing


To try out regl right away, you can use the live editor in the gallery.

npm


The easiest way to use regl in a project is via npm.  Once you have node set up, you can install and useregl in your project using the following command:

  1. ```sh
  2. npm i -S regl
  3. ```

For more info on how to use npm, check out the official docs.

If you are using npm, you may also want to try [budo](https://github.com/mattdesl/budo) which is a live development server.

Run time error checking and browserify


By default if you compile regl with browserify then all error messages and run time checks are removed.  This is done to reduce the size of the final bundle.  If you are developing an application, you should run browserify using the --debug flag in order to enable error messages.  This will also generate source maps which make reading the source code of your application easier.

Standalone script tag


You can also use regl as a standalone script if you are really stubborn.  The most recent versions can be found in the dist/ folder and is also available from npm cdn in both minified and unminified versions.

Unminified: https://npmcdn.com/regl/dist/regl.js
Minified: https://npmcdn.com/regl/dist/regl.min.js

There are some difference when using regl in standalone.  Because script tags don't assume any sort of module system, the standalone scripts inject a global constructor function which is equivalent to the module.exports of regl:

  1. ``` html
  2. <!DOCTYPE html>
  3. <html>
  4.   <head>
  5.     <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport" />
  6.     <meta charset=utf-8>
  7.   </head>
  8.   <body>
  9.   </body>
  10.   <script language="javascript" src="https://npmcdn.com/regl/dist/regl.js"></script>
  11.   <script language="javascript">
  12.     var regl = createREGL()
  14.     regl.frame(function () {
  15.       regl.clear({
  16.         color: [0, 0, 0, 1]
  17.       })
  18.     })
  19.   </script>
  20. </html>
  21. ```

Why regl


regl just removes shared state from WebGL.  You can do anything you could in regular WebGL with little overhead and way less debugging. regl emphasizes the following values:

Simplicity The interface is concise and emphasizes separation of concerns.  Removing shared state helps localize the effects and interactions of code, making it easier to reason about.
Correctness regl has more than 30,000 unit tests and above 95% code coverage. In development mode, regl performs strong validation and sanity checks on all input data to help you catch errors faster.
Performance  regl uses dynamic code generation and partial evaluation to remove almost all overhead.
Minimalism regl just wraps WebGL.  It is not a game engine and doesn't have opinions about scene graphs or vector math libraries.   Any feature in WebGL is accessible, including advanced extensions like multiple render targets or instancing.
Stability regl takes interface compatibility and semantic versioning seriously, making it well suited for long lived applications that must be supported for months or years down the road.  It also has no dependencies limiting exposure to risky or unplanned updates.

Comparisons


While regl is lower level than many 3D engines, code written in it tends to be highly compact and flexible.  A comparison of regl to various other WebGL libraries across several tasks can be found here.

Benchmarks


In order to prevent performance regressions, regl is continuously
benchmarked.  You can run benchmarks locally using npm run bench or
[check them out
online](https://regl-project.github.io/regl/www/bench.html). The
[results for the last few days can be found
here.](https://regl-project.github.io/regl/www/bench-results/bench-result-db4b76e25bd8ed6d7ed9)

These measurements were taken using our custom scripts bench-history and
bench-graph. You can read more about them in the development guide.

Projects using regl


The following is an incomplete list of projects using regl:

538 Gun Deaths
Infinite Terrain Demo
GPGPU Smooth Life
Summed Area Tables
GPGPU Fourier Analysis
GPU accelerated handwritten digit recognition with regl using Convolutional Neural Networks
Bokeh

If you have a project using regl that isn't on this list that you would like to see added, please send us a pull request!

Help Wanted


regl is still under active developement, and anyone willing to contribute is very much welcome to do so. Right now, what we need the most is for people to write examples and demos with the framework. This will allow us to find bugs and deficiencies in the API. We have a list of examples we would like to be implemented here, but you are of course welcome to come up with your own examples. To add an example to our gallery of examples, please send us a pull request!

API docs


regl has extensive API documentation.  You can browse the docs online here.

Development


The latest changes in regl can be found in the CHANGELOG.

For info on how to build and test headless, see the contributing guide here

License


All code (c) 2016 MIT License

Development supported by the Freeman Lab and the Howard Hughes Medical Institute (@freeman-lab on GitHub)

Asset licenses


Many examples use creative commons or public domain artwork for illustrative purposes.  These assets are not included in any of the redistributable packages of regl.

Peppers test image for cube comparison is public domain
Test video (doggie-chromakey.ogv) by L0ckergn0me, used under creative commons license
Cube maps (posx.jpeg, negx.jpeg, posy.jpeg, negy.jpeg, posz.jpeg, negz.jpeg) by Humus, used under creative commons 3 license
Environment map of Oregon (ogd-oregon-360.jpg) due to Max Ogden (@maxogd on GitHub)
DDS test images (alpine_cliff_a, alpine_cliff_a_norm, alpine_cliff_a_spec) taken from the CC0 license 0-AD texture pack by Wildfire games
Tile set for tile mapping demo (tiles.png) from CC0 licensed cobblestone paths pack
Audio track for audio.js example is "Bamboo Cactus" by 8bitpeoples.  CC BY-ND-NC 1.0 license
Matcap (spheretexture.jpg) by Ben Simonds. CC 3 license.
Normal map (normaltexture.jpg) by rubberduck. CC0 license.