README
GLFW for Node.js
This is a part of Node3D project.
npm i glfw-raub
Synopsis
Node.js addon with GLFW3 bindings.
Note: this addon uses N-API, and therefore is ABI-compatible across different Node.js versions. Addon binaries are precompiled and there is no compilation step during the
npm i
command.
- GLFW version 3.3.4 backend.
- Exposes low-level GLFW interface.
- Multiple windows for a single Node.js process.
- Able to switch to fullscreen and back.
- Has
Window
class, simplifying low-level interactions. - Has
Document
class, capable of tricking other libs, as if we are in a browser.
GLFW
This is a low-level interface, where most of the stuff is directly reflecting GLFW API. It does NOT EXPOSE OpenGL commands. See GLFW Docs for useful info on what it does and doesn't.
const glfw = require('glfw-raub');
Here glfw
is an API container, where all glfw*
functions are accessible as
glfw.*
. E.g. glfwSetWindowTitle
-> glfw.setWindowTitle
.
See TypeSctipt defenitions for more details.
class Window
const { Window } = glfw;
See TypeSctipt defenitions for more details.
class Document
const { Document } = glfw;
See TypeSctipt defenitions for more details.