Update readme

Author: raub

README.md

@@ -46,42 +46,77 @@ step during the `npm i` command.
 ## 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](http://www.glfw.org/docs/latest/group__window.html)
-for useful info on what it does and doesn't.
-
-```js
-const glfw = require('glfw-raub');
+GLFW API. GLFW **does NOT EXPOSE** OpenGL commands, it only [controls the window-related
+setup and resources](http://www.glfw.org/docs/latest/group__window.html).
+Aside from several additional features, this addon directly exposes the GLFW API to JS. E.g.:
+
+```cpp
+DBG_EXPORT JS_METHOD(pollEvents) {
+	glfwPollEvents();
+	RET_GLFW_VOID;
+}
 ```
 
-Here `glfw` is an API container, where all `glfw*` functions are accessible as
-`glfw.*`. E.g. `glfwSetWindowTitle` -> `glfw.setWindowTitle`.
+Nothing is added between you and GLFW, unless necessary or explicitly mentioned.
+
+* All `glfw*` functions are accessible as
+    `glfw.*`. E.g. `glfwPollEvents` -> `glfw.pollEvents`.
+* All `GLFW_*` constants are accessible as
+    `glfw.*`. E.g. `GLFW_TRUE` -> `glfw.TRUE`.
 
-See [TypeScript definitions](/index.d.ts) for more details.
+
+See [this example](/examples/vulkan.mjs) for raw GLFW calls.
+
+See [TS declarations](/index.d.ts) for more details.
 
 ----------
 
 
 ### class Window
 
 ```js
-const { Window } = require('glfw-raub');
+const { Window } = glfw;
+const wnd = new Window({ title: 'GLFW Test', vsync: true });
 ```
 
 This class helps managing window objects and their events. It can also switch between
 fullscreen, borderless and windowed modes.
 
-See [TypeScript definitions](/index.d.ts) for more details.
+The first window creates an additional invisible root-window for context sharing.
+(so that you can also close any window and still keep the root context).
+The platform context (pointers/handles) for sharing may be obtained when necessary.
+
+See [TS declarations](/index.d.ts) for more details.
 
 ----------
 
 ### class Document
 
 ```js
-const { Document } = require('glfw-raub');
+const { Document } = glfw;
+const doc = new Document({ title: 'GLFW Test', vsync: true });
 ```
 
-It can be used to facilitate the environment for other
-JS libraries, such as [three.js](https://threejs.org/).
+Document inherits from `Window` and has the same features in general.
+It exposes additional APIs to mimic the content of web `document`.
+There are some tricks to provide WebGL libraries with necessary environment.
+Document is specifically designed for compatibility with [three.js](https://threejs.org/).
+Other web libraries may work too, but may require additional tweaking.
+
+See [TS declarations](/index.d.ts) for more details.
+
+----------
 
-See [TypeScript definitions](/index.d.ts) for more details.
+### Extras
+
+* `glfw.hideConsole(): void` - tries to hide the console window on Windows.
+* `glfw.showConsole(): void` - shows the console window if it has been hidden.
+* `glfw.drawWindow(w: number, cb: (dateNow: number) => void): void` - this is a shortcut
+    to call `pollEvents`, then `cb`, and then `swapBuffers`, where you only supply `cb`
+    and C++ side does the rest.
+* `glfw.platformDevice(w: number): number` - returns the window HDC on Windows,
+    or whatever is similar on other systems.
+* `glfw.platformWindow(w: number): number` - returns the window HWND on Windows,
+    or whatever is similar on other systems.
+* `glfw.platformContext(w: number): number` - returns the window WGL Context on Windows,
+    or whatever is similar on other systems.

src/cpp/glfw-common.hpp

@@ -36,6 +36,15 @@
 #define RET_GLFW_VOID                                                         \
 	return glfw::undefined;
 
+inline Napi::Number NewInt64(napi_env env, int64_t val) {
+	napi_value value;
+	napi_status status = napi_create_double(env, val, &value);
+	NAPI_THROW_IF_FAILED(env, status, Napi::Number());
+	return Napi::Number(env, value);
+}
+
+#define RET_PTR(VAL) return NewInt64(env, reinterpret_cast<int64_t>(VAL))
+	
 namespace glfw {
 	Napi::Value undefined;
 }

src/cpp/glfw-platform.cpp

@@ -11,46 +11,46 @@ namespace glfw {
 
 DBG_EXPORT JS_METHOD(platformDevice) { NAPI_ENV;
 #ifdef _WIN32
-	RET_NUM(reinterpret_cast<uint64_t>(wglGetCurrentDC()));
+	RET_PTR(wglGetCurrentDC());
 #elif __linux__
 	if (glfwGetPlatform() == GLFW_PLATFORM_WAYLAND) {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetWaylandDisplay()));
+		RET_PTR(glfwGetWaylandDisplay());
 	} else {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetX11Display()));
+		RET_PTR(glfwGetX11Display());
 	}
 #elif __APPLE__
 	CGLContextObj kCGLContext = CGLGetCurrentContext();
-	RET_NUM(reinterpret_cast<uint64_t>(CGLGetShareGroup(kCGLContext)));
+	RET_PTR(CGLGetShareGroup(kCGLContext));
 #endif
 }
 
 
 DBG_EXPORT JS_METHOD(platformWindow) { NAPI_ENV; THIS_WINDOW;
 #ifdef _WIN32
-	RET_NUM(reinterpret_cast<uint64_t>(glfwGetWin32Window(window)));
+	RET_PTR(glfwGetWin32Window(window));
 #elif __linux__
 	if (glfwGetPlatform() == GLFW_PLATFORM_WAYLAND) {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetWaylandWindow(window)));
+		RET_PTR(glfwGetWaylandWindow(window));
 	} else {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetX11Window(window)));
+		RET_PTR(glfwGetX11Window(window));
 	}
 #elif __APPLE__
-	RET_NUM(reinterpret_cast<uint64_t>(glfwGetCocoaWindow(window)));
+	RET_PTR(glfwGetCocoaWindow(window));
 #endif
 }
 
 
 DBG_EXPORT JS_METHOD(platformContext) { NAPI_ENV; THIS_WINDOW;
 #ifdef _WIN32
-	RET_NUM(reinterpret_cast<uint64_t>(glfwGetWGLContext(window)));
+	RET_PTR(glfwGetWGLContext(window));
 #elif __linux__
 	if (glfwGetPlatform() == GLFW_PLATFORM_WAYLAND) {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetEGLContext(window)));
+		RET_PTR(glfwGetEGLContext(window));
 	} else {
-		RET_NUM(reinterpret_cast<uint64_t>(glfwGetGLXContext(window)));
+		RET_PTR(glfwGetGLXContext(window));
 	}
 #elif __APPLE__
-	RET_NUM(reinterpret_cast<uint64_t>(glfwGetNSGLContext(window)));
+	RET_PTR(glfwGetNSGLContext(window));
 #endif
 }