Skip to content

Commit 1b2a2ab

Browse files
authored
[Docs] Added note to clarify new glfw3 port (#21272)
1 parent 31e823d commit 1b2a2ab

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

site/source/docs/compiling/Contrib-Ports.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ available in emscripten. In order to use a contrib port you use the
1717
contrib.glfw3
1818
=============
1919

20-
This project is an emscripten port of glfw written in C++ for the web/webassembly platform
20+
This project is an emscripten port of GLFW written in C++ for the
21+
web/webassembly platform.
22+
23+
.. note::
24+
emscripten includes support for both GLFW 2 and 3 written in Javascript.
25+
These can be activated with the :ref:`settings <use_glfw>` ``-sUSE_GLFW=2``
26+
and ``-sUSE_GLFW=3``. This non-official contribution, written in C++,
27+
provides a more extensive and up-to-date implementation of the GLFW 3 API
28+
than the built-in port. It is enabled with the option
29+
``--use-port=contrib.glfw3``.
2130

2231
`Project information <https://github.com/pongasoft/emscripten-glfw>`_
2332

tools/ports/contrib/glfw3.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
# contrib port information (required)
1212
URL = 'https://github.com/pongasoft/emscripten-glfw'
13-
DESCRIPTION = 'This project is an emscripten port of glfw written in C++ for the web/webassembly platform'
13+
DESCRIPTION = 'This project is an emscripten port of GLFW written in C++ for the web/webassembly platform'
1414
LICENSE = 'Apache 2.0 license'
1515

1616

0 commit comments

Comments
 (0)