Commit Graph

52 Commits

Author SHA1 Message Date
Camilla Löwy
fb10e95f78 Add language tags for C code sections 2024-02-13 21:28:24 +01:00
TheChocolateOre
2e12ef00bb
Fix typos and other issues in docs
This fixes spelling, grammar and punctuation issues, missing words and
stray words across the documentation.  A confusing sentence was removed
from the tutorial.

Closes #2085
2022-07-28 15:56:18 +02:00
Camilla Löwy
399c2a1fad Clarify docs on default GL header inclusion
The documentation claims that any extension loader library header
included before the GLFW one will prevent the inclusion of the
default OpenGL header.  In reality this only worked if the loader
defined the canonical desktop OpenGL __gl_h_ inclusion guard and even
then relied on the OpenGL header to detect this.

This is the companion to 105cf32e0b, which
added the preprocessor logic to check for many known OpenGL and OpenGL
ES inclusion guards and not even attempt to include the default header
if any are present.

Some clarification of the language around header inclusion has also been
attempted, including making GLFW_INCLUDE_NONE more prominent.

Fixes #1695.
2020-06-02 18:04:49 +02:00
Camilla Löwy
d7ae90a790 Update community resource links 2020-05-05 00:38:14 +02:00
Camilla Löwy
feaa532886 Add missing word 2019-05-24 14:43:49 +02:00
Camilla Löwy
e4aba7feaa Convert triangle-opengl example to 3.3 core 2019-05-24 14:43:49 +02:00
Camilla Löwy
a639d6e635 Rename OpenGL triangle example to triangle-opengl 2019-05-24 14:43:39 +02:00
Camilla Löwy
d7e30b1c74 Replace glad and the Vulkan SDK with glad2
This removes all dependencies from the GLFW test programs on the Vulkan
SDK.

It also removes support for linking the GLFW shared library (dynamic
library, DLL) against the Vulkan loader static library.
2019-04-15 02:45:48 +02:00
MrVallentin
85fd5aa6c4 Use HTTPS when possible 2018-11-03 11:57:47 +01:00
Emmanuel Gil Peyrot
c3cba58a71 Remove trailing whitespace 2017-12-14 15:36:55 +01:00
Camilla Löwy
1be81a1540 Documentation work 2017-10-22 16:30:19 +02:00
Camilla Berglund
8d6f265441 Update default name from OS X to macOS
Note that earlier releases are still referred to by their proper names;
OS X <version> or Mac OS X <version>.
2016-10-20 00:53:37 +02:00
Camilla Berglund
80c203f3bb Separate guide and reference documentation tags 2016-02-19 10:38:30 +01:00
Camilla Berglund
58a83ca8ad Documentation work 2016-02-04 20:34:22 +01:00
Camilla Berglund
43d6292328 Formatting 2015-11-07 21:08:25 +01:00
Camilla Berglund
ba1f1f8ee9 Update tutorial
Related to #628.
2015-10-28 23:26:57 +01:00
Camilla Berglund
f47e2f3ae4 Documentation work 2015-10-24 21:28:28 +02:00
Camilla Berglund
318e8acfae Header file documentation work 2015-10-24 21:18:52 +02:00
Camilla Berglund
b312f5e208 Fix grammar 2015-10-24 20:28:25 +02:00
Camilla Berglund
c9040bce55 Improve tutorial ending 2015-10-24 20:28:25 +02:00
Camilla Berglund
ce52210832 Add note about non-magic boolean values 2015-10-24 20:28:25 +02:00
Camilla Berglund
143c52e4cd Add OpenGL tutorial links to tutorial 2015-10-24 20:28:25 +02:00
Camilla Berglund
156cd33c7f Add use of glad to tutorial 2015-10-24 20:28:25 +02:00
Camilla Berglund
bbae72cea2 Improve header section of tutorial 2015-10-24 20:28:24 +02:00
Camilla Berglund
02b1710ab2 Remove mention of GLU from tutorial 2015-10-24 20:28:24 +02:00
Camilla Berglund
0eccf75f65 Replace GL booleans with public macros 2015-10-13 00:46:02 +02:00
Camilla Berglund
be65829055 Clarify GLU deprecation 2015-10-12 19:05:21 +02:00
Camilla Berglund
4188c263e3 Documentation work. 2015-01-18 17:30:10 +01:00
Camilla Berglund
4e375d0e74 Documentation work. 2015-01-11 18:25:54 +01:00
Pontus Stenetorp
e132945f71 Added missing article.
Fixes #409.
2015-01-06 00:02:43 +01:00
Camilla Berglund
95654cfada Documentation work. 2014-10-06 15:01:58 +02:00
Camilla Berglund
4591ad2d64 Documentation work. 2014-09-22 11:08:33 +02:00
Camilla Berglund
e8e05d462c Documentation work.
Fixes #276.
2014-06-19 11:38:22 +02:00
Camilla Berglund
c9808586b3 Added GLFW_DOUBLEBUFFER. 2014-06-18 16:36:53 +02:00
Camilla Berglund
1f6696d433 Added references to build guide. 2013-09-24 22:17:35 +02:00
Camilla Berglund
4b7ae4918b Documentation work. 2013-07-07 12:59:30 +02:00
Camilla Berglund
ee91dea741 Added key input to quick tutorial. 2013-06-05 23:46:16 +02:00
Camilla Berglund
fbfbf3ce07 Documentation work. 2013-06-05 21:26:40 +02:00
Camilla Berglund
ad1f6f0341 Renamed glfwGetWindowParam to glfwGetWindowAttrib.
Parameters are something specified at creation time and are often
immutable, while many of the values returned by glfwGetWindowParam
reflected current state not controlled by any parameter or hint.
2013-05-27 15:30:32 +02:00
Camilla Berglund
15ed715f4e Moved public headers to the GLFW directory. 2013-05-22 22:46:34 +02:00
Camilla Berglund
19cfc5e6f2 Grammar fix. 2013-05-19 10:24:59 +02:00
Camilla Berglund
8282a8fbe0 Documentation work. 2013-04-10 23:01:12 +02:00
Camilla Berglund
e248fb6056 Documentation work. 2013-04-08 03:26:54 +02:00
Camilla Berglund
13ccf7d9de Fixed bullet lists. 2013-04-07 13:50:53 +02:00
Camilla Berglund
87af36830c Added reference to example source file. 2013-03-18 15:57:58 +01:00
Camilla Berglund
c5ea91d6a3 Added tables of contents. 2013-03-12 18:57:38 +01:00
Camilla Berglund
71d2b574f8 Converted docs to hybrid Markdown. 2013-03-12 15:33:05 +01:00
Camilla Berglund
64afb193e8 Removed return value of close callback. 2013-03-06 23:29:37 +01:00
Camilla Berglund
6fadf37bda Replaced window close parameter with mutable flag.
Replaced the GLFW_SHOULD_CLOSE window parameter with the
glfwWindowShouldClose and glfwSetWindowShouldClose functions, allowing
the setting of the close flag from any point in the program.
2013-03-01 14:13:45 +01:00
Camilla Berglund
f8f81e5754 Documentation work. 2013-02-28 21:49:24 +01:00