emscripten-glfw

emscripten-glfw copied to clipboard

Introduction

This project is an emscripten port of GLFW written in C++ for the web/wasm platform. The currently supported GLFW API is 3.4.

Goal

The main goal of this project is to implement as much as the GLFW API possible (in a browser context).

Since this project is targeting the web/webassembly platform, which runs in more recent web browsers, it is also trying to focus on using the most recent features and not use deprecated features (for example, uses keyboardEvent.key vs keyboardEvent.charcode). As a result, this implementation will most likely not work in older browsers.

Since the code is written in C++, it is trying to minimize the amount of javascript code to remain clean and lean.

Features

Main supported features:

• can create as many windows as you want, each one associated to a different canvas (use emscripten_glfw_set_next_window_canvas_selector("#canvas2") to specify which canvas to use)
• resizable window/canvas (use emscripten_glfw_make_canvas_resizable(...) to make the canvas resizable by user. Use "window" as the resize selector for full frame canvas (ex: ImGui))
• mouse (includes sticky button behavior)
• keyboard (includes sticky key behavior)
• joystick/gamepad
• fullscreen
• Hi DPI
• all glfw cursors
• window opacity
• size constraints (size limits and aspect ratio)
• visibility
• focus
• timer

Demo

Checkout the live demo of the example code. Note that you need to use a "modern" browser to see it in action. Currently tested on Google Chrome 120+ and Firefox 121+.

The code for the demo is included in this project.

The demo shows 2 canvases each created via a glfwCreateWindow and shows how they respond to keyboard and mouse events (using direct apis, like glfwGetMouseButton or callback apis like glfwSetMouseButtonCallback)

• canvas1 is hi dpi aware (glfwWindowHint(GLFW_SCALE_FRAMEBUFFER, GLFW_TRUE))
• canvas2 is not hi dpi aware (but can be made so with the "Enable" Hi DPI Aware button)
• canvas2 is fully resizable (use the square handle to resize) (emscripten_glfw_make_canvas_resizable(window2, "#canvas2-container", "#canvas2-handle"))

You can enable/disable each window/canvas independently:

• When 2 (or more) canvases are present, the canvas that has focus can receive keyboard events. If no other element on the page has focus, then the last canvas that had the focus will receive these events. Clicking with the left mouse button on a canvas gives it focus.
• When there is only 1 canvas, the implementation try to be smart about it and will route keyboard (and other relevant) events to the single canvas provided that nothing else has focus (the 'Change focus/Text' field is used to test this feature since clicking in the text field grabs the focus).

The demo uses webgl to render a triangle (the hellow world of gpu rendering...).

Examples

Usage

Check the Usage documentation for details on how to use this implementation. Note that care has been taken to backward compatible with the pure javascript implementation built-in in emscripten.

Building

Using emscripten port

Since emscripten 3.1.55, using this port is really easy via the --use-port=contrib.glfw3 option (no need to clone this repo at all!). This is the recommended method to use this project.

Example:

emcc --use-port=contrib.glfw3 main.cpp -o build/index.html

The port can be configured with the following options:

Example using disableWarning and disableMultiWindow:

emcc --use-port=contrib.glfw3:disableWarning=true:disableMultiWindow=true main.cpp -o build

Note about availability in emscripten

this port	emscripten
3.4.0.20240501	TBD
3.4.0.20240318	3.1.57
1.1.0	3.1.56
1.0.5	3.1.55

Due to the release cadence of emscripten, if you want to be in charge of which version you use, you can simply use the port that is checked-in under port: --use-port=port/emscripten-glfw3.py

Note

Emscripten automatically downloads and builds the library for you and stores it in its cache. If you want to delete the library from the cache, you can use the embuilder tool:

# remove library from cache
embuilder clear contrib.glfw3
# remove library from cache (with options)
embuilder clear contrib.glfw3:disableWarning=true:disableMultiWindow=true

CMake

If you use CMake, you should be able to simply add this project as a subdirectory. Check CMakeLists.txt for an example of the build options used.

With CMake, you can set the (CMake) option EMSCRIPTEN_GLFW3_DISABLE_JOYSTICK if your application does not care about supporting joystick as it can be an extra burden on size and runtime polling.

You can also set the (CMake) option EMSCRIPTEN_GLFW3_DISABLE_MULTI_WINDOW_SUPPORT if your application does not need multi window support, and you want a smaller code and faster execution.

When compiling in Release mode, the compilation flag EMSCRIPTEN_GLFW3_DISABLE_WARNING is automatically set.

Makefile

For testing purposes, I am successfully building ImGui (examples/example_emscripten_wgpu) against this implementation with the following section in the Makefile:

# local glf3 port
EMS_GLFW3_DIR = /Volumes/Development/github/org.pongasoft/emscripten-glfw
SOURCES += $(EMS_GLFW3_DIR)/src/cpp/glfw3.cpp
SOURCES += $(EMS_GLFW3_DIR)/src/cpp/emscripten/glfw3/Context.cpp \
           $(EMS_GLFW3_DIR)/src/cpp/emscripten/glfw3/ErrorHandler.cpp \
           $(EMS_GLFW3_DIR)/src/cpp/emscripten/glfw3/Keyboard.cpp \
           $(EMS_GLFW3_DIR)/src/cpp/emscripten/glfw3/Joystick.cpp \
           $(EMS_GLFW3_DIR)/src/cpp/emscripten/glfw3/Window.cpp

# ("EMS" options gets added to both CPPFLAGS and LDFLAGS, whereas some options are for linker only)
#EMS += -s DISABLE_EXCEPTION_CATCHING=1
#LDFLAGS += -s USE_GLFW=3 -s USE_WEBGPU=1
LDFLAGS += -s USE_WEBGPU=1 --js-library $(EMS_GLFW3_DIR)/src/js/lib_emscripten_glfw3.js
#LDFLAGS += -s WASM=1 -s ALLOW_MEMORY_GROWTH=1 -s NO_EXIT_RUNTIME=0 -s ASSERTIONS=1

Note

The previous Makefile is shown as an illustration of what a Makefile to compile this project would look like. The actual changes required for ImGui are actually much simpler:

#LDFLAGS += -s USE_GLFW=3 -s USE_WEBGPU=1
LDFLAGS += --use-port=contrib.glfw3 -s USE_WEBGPU=1

Release Notes

3.4.0.20240501 - 2024-05-01 | emscripten TBD

• Fixed issue when calling glfwGetWindowContentScale with nullptr
• Renamed javascript api/impl since these names are not unique to avoid potential conflicts
• Added glfw3native.h to GLFW. Although not used (at this moment) by this implementation, this allows calling code to include it if necessary since it is part of a normal GLFW installation.

3.4.0.20240318 - 2024-03-18 | emscripten 3.1.57

• Fixed joystick/gamepad code that was improperly mapping GLFW_GAMEPAD_AXIS_LEFT_TRIGGER GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER, GLFW_GAMEPAD_BUTTON_LEFT_THUMB and GLFW_GAMEPAD_BUTTON_RIGHT_THUMB
• GLFW_GAMEPAD_AXIS_LEFT_TRIGGER and GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER are now properly represented as an analog value in the range [-1.0, +1.0]
• Please note the change in version numbering which from now on will be tied to the GLFW version implemented + date of release of this port to avoid confusion

1.1.0 - 2024-02-29 | emscripten 3.1.56

• Upgraded to GLFW 3.4
• GLFW 3.4 features implemented
  • glfwGetPlatform and glfwPlatformSupported uses the GLFW_PLATFORM_EMSCRIPTEN constant defined in emscripten-glfw3.h (officially reserved value is 0x00060006)
  • glfwInitHint supports the new hint GLFW_PLATFORM
  • Supports all 10 cursors
  • Implemented glfwGetWindowTitle
  • Use GLFW_SCALE_FRAMEBUFFER to enable (resp. disable) Hi DPI support
  • Changed the functions that can report GLFW_FEATURE_UNAVAILABLE failure to report this error instead of a warning
• GLFW 3.4 features not implemented
  • GLFW_MOUSE_PASSTHROUGH is not supported
  • GLFW_CURSOR_CAPTURED cursor input mode is not supported (not possible in a browser context)
  • glfwInitAllocator is implemented as noop (could be supported for the C++ part only if there is demand, not javascript)
  • GLFW_POSITION_X and GLFW_POSITION_Y are not supported (same as glfwSetWindowPos)
  • GLFW_ANGLE_PLATFORM_TYPE is not supported (no direct access in browser, but implementation is most likely using it anyway)
• Since GLFW 3.4 introduces a proper constant to handle Hi DPI Awareness (GLFW_SCALE_FRAMEBUFFER), the prior constant used by this port (GLFW_SCALE_TO_MONITOR) is still accepted, but it is now deprecated. In addition, due to the fact that GLFW_SCALE_FRAMEBUFFER defaults to GLFW_TRUE, this port is now Hi DPI aware by default and needs to be explicitly turned off (glfwWindowHint(GLFW_SCALE_FRAMEBUFFER, GLFW_FALSE)) if this is the desired behavior.

1.0.5 - 2024/02/18 | emscripten 3.1.55

• Fixed memory corruption with joystick

1.0.4 - 2024/01/24

• Fixed version string

1.0.3 - 2024/01/23

• Fixed emscripten_glfw3.h to work as a C file
• Added create-archive target

1.0.2 - 2024/01/22

• Added EMSCRIPTEN_GLFW3_DISABLE_JOYSTICK as a CMake option
• Made joystick code truly conditional on EMSCRIPTEN_GLFW3_DISABLE_JOYSTICK define
• Added EMSCRIPTEN_GLFW3_DISABLE_MULTI_WINDOW_SUPPORT as a CMake option and made the multi window code conditional on EMSCRIPTEN_GLFW3_DISABLE_MULTI_WINDOW_SUPPORT define
• Misc: added GitHub workflow to compile the code/display badge

1.0.1 - 2024/01/21

• Fixed import

1.0.0 - 2024/01/21

• First 1.0.0 release
• Added examples
• Added documentation
• Fixed some issues
• Removed GLFW_EMSCRIPTEN_CANVAS_SELECTOR window hint in favor of a new api emscripten_glfw_set_next_window_canvas_selector
• Removed GLFW_EMSCRIPTEN_CANVAS_RESIZE_SELECTOR and Module.glfwSetCanvasResizableSelector in favor of a new api emscripten_glfw_make_canvas_resizable
• This new api also offer the ability to deal with the handle automatically
• Implemented getWindowPosition (canvas position in the browser window)
• Implemented all timer apis (glfwSetTime, glfwGetTimerValue and glfwGetTimerFrequency)
• Implemented glfwExtensionSupported
• Implemented glfwSetWindowTitle (changes the browser window title)

wip-0.5.0 - 2024/01/12

• Added support for resizable canvas (glfwWindowHintString(GLFW_EMSCRIPTEN_CANVAS_RESIZE_SELECTOR, "#canvas2-container") from c/c++ code or Module.glfwSetCanvasResizableSelector('#canvas2', '#canvas2-container') from javascript)
• Added support fo visibility (glfwShowWindow and glfwHideWindow)
• Added support for GLFW_FOCUS_ON_SHOW window hint/attribute
• Added support for dynamic Hi DPI Awareness (GLFW_SCALE_FRAMEBUFFER can be used in glfwSetWindowAttrib)
• Added support for "sticky" mouse button and keyboard
• Added support for window size constraints (glfwSetWindowSizeLimits and glfwSetWindowAspectRatio)
• Added support for providing a callback function in javascript to be notified when a window is created (Module.glfwOnWindowCreated)

wip-0.4.0 - 2024/01/03

• Added support for joystick/gamepad
  • Joystick support can be disabled via EMSCRIPTEN_GLFW3_DISABLE_JOYSTICK compilation flag

wip-0.3.0 - 2023/12/31

• Added support for input mode GLFW_CURSOR (handle all use cases: Normal / Hidden / Locked)
• Added support for glfw defined cursors (implemented glfwCreateStandardCursor and glfwSetCursor)
• Added support for window opacity (implemented glfwGetWindowOpacity and glfwSetWindowOpacity)

wip-0.2.0 - 2023/12/28

• remembers the last window that had focus so that some events can be sent to it even if no window has focus (ex: requesting fullscreen)
• added support for mouse wheel (glfwSetScrollCallback)
• added support for mouse enter/leave (glfwSetCursorEnterCallback)

wip-0.1.0 - 2023/12/26

• first public version

Misc

This project includes the glfw3.h header (external/GLFW/glfw3.h) which uses a ZLib license

Licensing

• Apache 2.0 License. This project can be used according to the terms of the Apache 2.0 license.