370 Commits

Author SHA1 Message Date
Camilla Löwy
7482de6071 Documentation work
Fixes #1596

(cherry picked from commit aa80d24d01d150e26d664ff2d5da22e95db6bb82)
2022-07-15 00:11:23 +02:00
Camilla Löwy
935d7098b6 Documentation work
(cherry picked from commit 2796e61af7b4d0c5f2380c3e1803e21ac1089029)
2022-07-15 00:11:23 +02:00
Emmanuel Gil Peyrot
581fed38be Wayland: Remove support for wl_shell
This is adapted to 3.3-stable from
599fb3de348f73134b4e9d2ee5cabc62ca0b84ab and
27295b508ffd098de8673bfe5f7f4154235cb1cc.
2022-07-13 22:40:46 +02:00
Camilla Löwy
aa1efada52 Add support for GLFW_NATIVE_INCLUDE_NONE macro
By default, the glfw3native.h header will include the platform-specific
headers necessary for the return types of GLFW native access functions.

Sometimes it is preferrable to declare those types

This commit adds support for the GLFW_NATIVE_INCLUDE_NONE macro, which
when defined disables the inclusion of all platform-specific headers.

Fixes #1348

(cherry picked from commit 05f6c13d119ea2662c97527d2421fb4cffd3dbfc)
2022-07-12 20:29:22 +02:00
Camilla Löwy
b86fcd7cd0 Cocoa: Use system header to declare id type
Related to #1348

(cherry picked from commit edec334b32458df9ced9d84a39c3cd4b757597bb)
2022-07-12 20:29:22 +02:00
Camilla Löwy
f001aa3490 Fix and clarify comments for GLFWAPI
(cherry picked from commit 685de9089f13dab9e284d00aaca24e68947f5bed)
2022-06-10 17:11:13 +02:00
Camilla Löwy
bf5529512c Document delayed initialization of EGL display
(cherry picked from commit 06089a91a644b1f1c44465c95ff6cc002792556b)
2022-06-09 19:50:00 +02:00
Camilla Löwy
802882f7cb Add checks for some invalid values to public API
There were no checks for invalid values or asserts for all invalid NULL
pointers to glfwSetWindowIcon or glfwCreateCursor.

Fixes #1862

(cherry picked from commit 66a4882eb14344115e9cda9f8c0f0c5d0362ca6e)
2022-05-06 19:34:05 +02:00
Camilla Löwy
c2188e2d0a Fix accidental C99 in C89 header
(cherry picked from commit add0521efb1fc0e95082716748b7aad837753fba)
2022-05-06 19:34:04 +02:00
Camilla Löwy
e7a81f8aaa Fix GLAPIENTRY redefinition warning
On a Unix system, if you define GLFW_INCLUDE_NONE and
GLFW_EXPOSE_NATIVE_GLX, then include glfw3.h and glfw3native.h, you will
get a redefinition warning for GLAPIENTRY.

The glfw3.h header defines GLAPIENTRY as a service for OpenGL related
headers that assume it's already defined.  However, glx.h includes gl.h,
which defines GLAPIENTRY unconditionally.

If not for Hyrum's law, the better solution would have been not to
define GLAPIENTRY if GLFW_INCLUDE_NONE is defined.

Fixes #2010

This is adapted to 3.3-stable from
535c3ce63240ee91f998219b35dc82abef545c3d and
ce85c7dcaf48be96870f2d8fec1d78b0b7d744c7.
2022-05-06 19:33:08 +02:00
Camilla Löwy
b43c122dd1 Start 3.3.8 2022-04-05 19:54:09 +02:00
Camilla Löwy
6afc571ade Wayland: Document delayed window showing
(cherry picked from commit 8edbc4971d6c994d84f12f349afdeef41fae527f)
2022-02-15 20:40:37 +01:00
Camilla Löwy
22eaa04b49 Update docs for specific Vulkan surface extensions
Related to #2014

(cherry picked from commit 05b0e2fab2be38e0c937bf2ba09f6dc892160616)
2022-02-15 20:39:40 +01:00
Camilla Löwy
869e68a015 Start 3.3.7 2021-12-10 01:26:54 +01:00
InKryption
7d5a16ce71 Add missing errors section for glfwGetGamepadName
The reference documentation for glfwGetGamepadName lacked the possible
errors section.

Closes #2007

(cherry picked from commit c19f36b28d255d280d39446f09f36f441318138e)
2021-12-08 20:23:20 +01:00
Stephen Gutekanst
81d762bf66 Fix docs calling GLFW_CONTEXT_REVISION a hint
This docstring previously indicated that GLFW_CONTEXT_REVISION was
a window hint and attribute, but in fact it is only a window attribute
(there is no code which uses this constant in any other context.)

We noticed this in https://github.com/hexops/mach/pull/71/files#r749741814

Closes #1992

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
(cherry picked from commit 37fc28bff6cad7164aa67e828e9317596f8080da)
2021-11-30 19:04:56 +01:00
InKryption
c59092619a Add missing error to glfwGetClipboardString docs
Add GLFW_FORMAT_UNAVAILABLE to the list of possible errors in the
reference documentation for glfwGetClipboardString.

Slightly edited by @elmindreda.

Closes #1998

(cherry picked from commit bb193325cc4e5af7d4e715072a242c1d3cfce26e)
2021-11-30 19:03:59 +01:00
Camilla Löwy
19543afbfb Start 3.3.6 2021-10-28 22:16:41 +02:00
Camilla Löwy
b77a9b1d0d Fix GLFW_INCLUDE_GLEXT being ignored for glcorearb
The GLFW_INCLUDE_GLCOREARB branch was left out when GLFW_INCLUDE_GLEXT
was originally added, for reasons that are lost to history.  The current
versions of these headers seem to co-exist just fine.

Issue reported on IRC.

(cherry picked from commit 309d79376f31bddb75faed26efd1fe27b9365c06)
2021-10-28 12:31:02 +02:00
Camilla Löwy
73b6754a67 Document possible native access function errors
(cherry picked from commit 983c44b255a322bec7776faa870e43ef492d0656)
2021-10-28 12:13:36 +02:00
Camilla Löwy
9400bc9f35 Remove potentially incorrect claim
(cherry picked from commit 4be0444ee6462e9c06098462c9e2797f666798ad)
2021-10-13 23:11:53 +02:00
Camilla Löwy
1a7e4da343 Fix docs for Windows monitor size calculation
This sentence was truncated by 951a9583faf91bdbe96bacd5d24a8969c0cca418
and then not updated when content scale support was added with
16bf872117896fb88493403157fcd367303fd1f6.

(cherry picked from commit 6a200531026f383d7f5c260ae802c43be80c2cd7)
2021-10-13 23:11:48 +02:00
Camilla Löwy
ffe0795e64 Name parameters for callback function types
Started adding these because of Doxygen warnings but it should have been
done regardless.

(cherry picked from commit 4e557437f2e97945f57a86fc6a8c659bf5346098)
2021-08-27 17:20:08 +02:00
Camilla Löwy
e04cd8283e Add notes on getting the HDC of a window on Win32
Related to #1913.

(cherry picked from commit 15e05adf67203baf5c6c5349240208502c68b27c)
2021-06-25 00:23:11 +02:00
Camilla Löwy
2a5038e4e9 Fix header version macro descriptions in docs
(cherry picked from commit e17ffcd0db4541816ebf4cf973ebcee18e287733)
2021-06-09 18:33:44 +02:00
Camilla Löwy
30b02dd709 Fix description of video mode ordering in docs
The two final sorting criteria were not included in the documentation.

Fixes #1889.

(cherry picked from commit 0e9ec7788b4985a0df698080258e4091d18dcc3b)
2021-06-09 18:32:05 +02:00
Camilla Löwy
3cded29c2f Replace GL_ARB_debug_output in comments
(cherry picked from commit 85bce8a8ead47214404bc66c73aa49f13976a102)
2021-06-09 18:26:39 +02:00
Camilla Löwy
bcaf8daa72 Fix grammar in MoltenVK support docs
(cherry picked from commit 4c90e21e8f2d2b1edf5741527385cad9b71bc526)
2021-06-09 18:25:09 +02:00
Camilla Löwy
713711f5e9 Start 3.3.5 2021-04-08 20:48:17 +02:00
Camilla Löwy
b8202d9ca3 Start 3.3.4 2021-02-23 21:23:46 +01:00
Emmanuel Gil Peyrot
bbc4caf04c Fix typo in GLFWwindowmaximizefun documentation
Thanks brianzuvich!

Fixes #1764.

(cherry picked from commit 1ed1489831e32337c13fbcbac2c2562ac4163bd3)
2020-09-16 13:31:22 +02:00
Camilla Löwy
f921caf4a6 Re-word docs for GLFW_OPENGL_DEBUG_CONTEXT attrib
Related to #1720.

(cherry picked from commit 4e3b43383a1e738dfcf47205671246f2008a8d94)
2020-06-30 17:10:50 +02:00
Tatsuya Yatagawa
307ce3aa1a Fix GLU header inclusion being disabled
This fixes a regression introduced by
105cf32e0b05e207d4cd5efa462887569ca2116a where GLFW_INCLUDE_GLU had no
effect if the GLFW header detected an earlier OpenGL header or loader
library header.

Closes #1712.

(cherry picked from commit 81f475bccbc0e784e8327005f2e66e3546fe8da0)
2020-06-30 17:07:47 +02:00
A. Tombs
fb0c8d4662 Add statement to docs for glfwTerminate
It is safe to call glfwTerminate both before initialization and after
termination.

Closes #1698.

(cherry picked from commit 7486e12f88b2a9039b805356bcbe259c0fca5c2d)
2020-06-02 19:01:25 +02:00
Camilla Löwy
78ad4e8f36 Fix desktop GL header not always being suppressed
If an OpenGL ES header or the glcorearb header is included before the
GLFW header (with no options defined), the legacy OpenGL header will be
implicitly included and the compilation will fail.

This disables the default behavior if we detect any known OpenGL, OpenGL
ES or extension loader inclusion guard macro.

Sources:
 - Khronos headers
 - Windows SDK
 - MinGW
 - MinGW-w64
 - flextGL
 - glad
 - glad2
 - GLEW
 - Galogen
 - gl3w
 - GLXW
 - glbinding
 - Epoxy
 - Glatter
 - glLoadGen
 - Regal
 - GLee
 - OpenGL.framework
 - Debian
 - FreeBSD
 - ANGLE
 - SwiftShader

Related to #1695.

(cherry picked from commit 105cf32e0b05e207d4cd5efa462887569ca2116a)
2020-06-02 19:01:21 +02:00
Camilla Löwy
8216a148cf Disambiguate Vulkan support reference link
(cherry picked from commit 41a19ed49c5ace44949f58b157714d59c2aebf2f)
2020-05-19 14:33:20 +02:00
Camilla Löwy
0ac013381b X11: Fix CJK IME input when locale CTYPE is "C"
Fixes #1587.
Fixes #1636.

(cherry picked from commit 4381b86b6ba63598de82c3f05824dc00a2b3ec59)
2020-02-13 22:03:51 +01:00
Camilla Löwy
64c7aa50d0 Start 3.3.3 2020-02-13 22:01:33 +01:00
ByunghoonKim
50f3979dfd Cocoa: Add support for VK_EXT_metal_surface
This adds optional support for the VK_EXT_metal_surface instance
extension.

Closes #1619.

(cherry picked from commit c5cb4a253a9c304b136cac01a378567dc46e0320)
2020-01-17 15:38:54 +01:00
Camilla Löwy
0938462616 Start 3.3.2 2020-01-05 14:50:14 +01:00
luz.paz
13a4e4e810 Fix typos
Found via `codespell -q 3 -S ./deps -L fo,numer,te,uint,wille`

(cherry picked from commit 7105ff2dfd004a46bd732c1d0c9f461bae6d51b3)
2019-09-23 15:27:17 +02:00
Camilla Löwy
79f4ec6822 Unify key name string handling
This makes key names per-key static strings for all supported platforms.

Fixes #1200.

(cherry picked from commit 56ca0cb3b30ecb1310752360e9c875fc1b2bab5e)
2019-09-23 15:26:23 +02:00
Lukas Zanner
452a648abb Fix typo in glfwGetRequiredInstanceExtensions docs
Closes #1500.

(cherry picked from commit 84b13113ed5e16aa29a0f5b4a0e95487081184a3)
2019-07-16 14:41:06 +02:00
Camilla Löwy
75b415c5b8 Cleanup
(cherry picked from commit 62b7fe831179428c3fa1d7939d48562772ee5647)
2019-07-16 14:40:58 +02:00
Camilla Löwy
248e827673 Win32: Fix symbol redefinition warnings
When both GLFW_INCLUDE_VULKAN and VK_USE_PLATFORM_WIN32_KHR were
defined, the GLFW header would define replacement versions of APIENTRY
and WINGDIAPI /before/ including the Vulkan header, which would include
windows.h, which (justifiably) defines APIENTRY and WINGDIAPI blindly.

Fixes #1524.

(cherry picked from commit 773f4495f005004ea17fbc4a96b6b1ce758e79d6)
2019-07-16 14:40:52 +02:00
Camilla Löwy
b962ef1241 Improve (?) reference documentation for callbacks
(cherry picked from commit 51bb76c7c3de934b2dd3affcdc297a32e4817835)
2019-05-27 16:34:45 +02:00
Camilla Löwy
e01128f32f Clarify difference between time and timer in docs
(cherry picked from commit bb6945a18ad4a33a2d2a0c9874da11e699978ed2)
2019-05-27 16:34:04 +02:00
Camilla Löwy
3afb2cc8ed Documentation work
Most context related hint and attribute links had copypaste errors.
The GLFW_CONTEXT_RELEASE_BEHAVIOR and GLFW_CONTEXT_NO_ERROR attributes
did not have guide documentation.

(cherry picked from commit 3cf7645b96c593d74f089069ac2e1c67938efd7f)
2019-05-27 16:29:05 +02:00
Camilla Löwy
a9343d641c Start 3.3.1 2019-04-16 14:48:16 +02:00
Camilla Löwy
ab118b2529 Fix copyright years (somewhat) 2019-04-15 20:50:00 +02:00