Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeseven/node-webgl
WebGL bindings to desktop OpenGL
https://github.com/mikeseven/node-webgl
Last synced: 5 days ago
JSON representation
WebGL bindings to desktop OpenGL
- Host: GitHub
- URL: https://github.com/mikeseven/node-webgl
- Owner: mikeseven
- Fork: true (creationix/node-webgl)
- Created: 2011-12-11T02:05:00.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2019-04-01T17:51:52.000Z (over 5 years ago)
- Last Synced: 2024-10-28T04:56:37.966Z (15 days ago)
- Language: JavaScript
- Homepage:
- Size: 4.49 MB
- Stars: 398
- Watchers: 20
- Forks: 60
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSES
Awesome Lists containing this project
README
This is a set of WebGL like bindings to OpenGL for Node.JS for desktops: windows, linux, mac
It started as an extension of creationix/node-webgl and their great example com.creationix.minimason that
you can find in examples/wavefront.js. However, it is now quite different and support different platform
bindings, mainly GLFW instead of SDL.
Unlike WebGL it calls directly into the OpenGL driver. This has the benefit of speed and
access to many features of desktop OpenGL at the expensive of compatibily and security.
If you're looking for an actual WebGL implementation for Node.JS see
[headless-gl](https://github.com/stackgl/headless-gl).
Dependencies
============
- node-glfw, which depends on GLEW, GLFW as well as AntTweakBar. See [node-glfw](https://github.com/mikeseven/node-glfw) for installation instructions.
- freeimage is used to load/save a variety of image formats.
- node-gyp if not already available in your distribution
Installation
============
`npm install node-webgl`
### Installation Notes for Windows 7
Beware of the Node.JS distribution you use. The default Node.JS is 32-bit and this means that modules
will be compiled by node-gyp with 32-bit settings, which often leads to compilation errors especially
on 64-bit systems.
So for Windows 7 64-bit, instead of downloading the default Node.JS windows installer, select 'Other release files'.
This will show you an ftp site for the latest release. Go into x64 folder and download that distribution.
### Installation Notes for OSX
`brew install anttweakbar freeimage`
Usage
=====
examples/ contains examples from other the web
test/ contains lessons from www.learningwebgl.com and other tests
simply type: `node test/lesson02.js`
Enjoy!
Limitations
===========
WebGL is based on OpenGL ES, a restriction of OpenGL found on desktops, for embedded systems.
Because this module wraps OpenGL, it is possible to do things that may not work on web browsers.
Please read http://www.khronos.org/webgl/wiki_1_15/index.php/WebGL_and_OpenGL_Differences
to learn about the differences.
- shaders
Remember to add this on top of your fragment shaders:
```glsl
#ifdef GL_ES
precision highp float;
#endif
```
- loading external scripts
If your code uses external libraries, you can load them like this. No code change to external scripts ;-)
```js
fs=require('fs');
eval(fs.readFileSync(__dirname+ '/glMatrix-0.9.5.min.js','utf8'));
```
- frame rate
`requestAnimationFrame(callback [, delay])` works as in the browser.
If delay is specified, it is the requested delay in milliseconds between animation frames
e.g. 16 will provide 1000 / 16 = 62 fps at best, which is the default value if delay is undefined.
If delay = 0, then the fastest possible framerate on your machine is used.
The timestamp now uses the high-resolution timer in your machine (not new Date()). This provides a much more precise
framerate as well as much better timing for animations.