https://github.com/evanw/lightgl.js
A lightweight WebGL library
https://github.com/evanw/lightgl.js
Last synced: 25 days ago
JSON representation
A lightweight WebGL library
- Host: GitHub
- URL: https://github.com/evanw/lightgl.js
- Owner: evanw
- License: mit
- Created: 2011-06-26T07:15:31.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2022-08-25T07:09:47.000Z (almost 3 years ago)
- Last Synced: 2025-04-01T00:38:03.354Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 687 KB
- Stars: 1,535
- Watchers: 59
- Forks: 145
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- creative-coding-resources - lightgl.js - A lightweight WebGL library. (Libraries)
README
# lightgl.js
This library makes it easier to quickly prototype WebGL applications. It's lower level than many other WebGL libraries and while it doesn't provide a scene graph, it re-implements OpenGL's modelview/projection matrix stack to provide similar functionality. It also re-introduces some built-in uniforms from GLSL (such as `gl_Vertex` and `gl_ModelViewProjectionMatrix`) and OpenGL's immediate mode.
## Building the library
* `python build.py`: build `lightgl.js` from the files in the `src` directory
* `python build.py debug`: rebuild the library any time the contents of the `src` directory change
* `python build.py release`: minify the library using [UglifyJS](https://github.com/mishoo/UglifyJS2), which assumes there is an `uglifyjs` command in your path
* `docco src/*.js`: build the documentation, which is generated in the `docs` directory
The latest lightgl.js build can be found at http://evanw.github.com/lightgl.js/lightgl.js.
## Sample code
```html
var angle = 0;
var gl = GL.create();
var mesh = GL.Mesh.cube();
var shader = new GL.Shader('\
void main() {\
gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;\
}\
', '\
void main() {\
gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);\
}\
');
gl.onupdate = function(seconds) {
angle += 45 * seconds;
};
gl.ondraw = function() {
gl.clear(gl.COLOR_BUFFER_BIT | gl.DEPTH_BUFFER_BIT);
gl.loadIdentity();
gl.translate(0, 0, -5);
gl.rotate(30, 1, 0, 0);
gl.rotate(angle, 0, 1, 0);
shader.draw(mesh);
};
gl.fullscreen();
gl.animate();
```
## Documentation
The documentation is automatically generated using [Docco](http://jashkenas.github.com/docco/):
* [main.js](http://evanw.github.com/lightgl.js/docs/main.html): `GL`
* [matrix.js](http://evanw.github.com/lightgl.js/docs/matrix.html): `GL.Matrix`
* [mesh.js](http://evanw.github.com/lightgl.js/docs/mesh.html): `GL.Indexer`, `GL.Buffer`, `GL.Mesh`
* [raytracer.js](http://evanw.github.com/lightgl.js/docs/raytracer.html): `GL.HitTest`, `GL.Raytracer`
* [shader.js](http://evanw.github.com/lightgl.js/docs/shader.html): `GL.Shader`
* [texture.js](http://evanw.github.com/lightgl.js/docs/texture.html): `GL.Texture`
* [vector.js](http://evanw.github.com/lightgl.js/docs/vector.html): `GL.Vector`
## Examples
Available examples:
* [Simple rotating cube](http://evanw.github.com/lightgl.js/tests/readme.html)
* [Multitexturing](http://evanw.github.com/lightgl.js/tests/multitexture.html)
* [First person camera](http://evanw.github.com/lightgl.js/tests/camera.html)
* [Scene manipulation](http://evanw.github.com/lightgl.js/tests/scenemanip.html)
* [OpenGL immediate mode](http://evanw.github.com/lightgl.js/tests/immediatemode.html)
* [Rendering to a texture](http://evanw.github.com/lightgl.js/tests/rtt.html)
* [Shadow map from a point light](http://evanw.github.com/lightgl.js/tests/shadowmap.html)
* [Realtime raytracing](http://evanw.github.com/lightgl.js/tests/raytracing.html)
* [Constructive solid geometry](http://evanw.github.com/lightgl.js/tests/csg.html)
* [GPU lightmap generation](http://evanw.github.com/lightgl.js/tests/gpulightmap.html)