From f1f947342740ecf6020c408a58c4441aa85977d9 Mon Sep 17 00:00:00 2001 From: Greggman Date: Tue, 27 Sep 2016 20:14:25 +0900 Subject: [PATCH] Update README.md to reflect OpenGL vs WebGL issues See Issue #53 --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ace4da53..c7f6aed5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ -This is a Node.JS port of WebGL for desktops: windows, linux, mac +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 for installation instructions.