Jiga228/glfw
0
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-09-17 22:32:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Separate guide and reference documentation tags

Browse Source
This commit is contained in:
Camilla Berglund
2016-02-19 10:29:13 +01:00
parent 001c50cfc6
commit 80c203f3bb
16 changed files with 107 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/main.dox
+14 -14
View File
@@ -11,20 +11,20 @@ for creating windows, contexts and surfaces, reading input, handling events, etc
See @ref news_32 for release highlights or the
[version history](http://www.glfw.org/changelog.html) for details.
@ref quick is a guide for those new to GLFW. It takes you through how to write
a small but complete program. For people coming from GLFW 2, the @ref moving
guide explains what has changed and how to update existing code to use the new
API.
@ref quick_guide is a guide for those new to GLFW. It takes you through how to
write a small but complete program. For people coming from GLFW 2, @ref
moving_guide explains what has changed and how to update existing code to use
the new API.
There are guides for each of the various areas of the API.
- @ref intro – initialization, error handling and high-level design
- @ref window – creating and working with windows and framebuffers
- @ref context – working with OpenGL and OpenGL ES contexts
- @ref monitor – enumerating and working with monitors and video modes
- @ref input – receiving events, polling and processing input
- @ref intro_guide – initialization, error handling and high-level design
- @ref window_guide – creating and working with windows and framebuffers
- @ref context_guide – working with OpenGL and OpenGL ES contexts
- @ref monitor_guide – enumerating and working with monitors and video modes
- @ref input_guide – receiving events, polling and processing input
Once you have written a program, see the @ref compile and @ref build guides.
Once you have written a program, see @ref compile_guide and @ref build_guide.
The [reference documentation](modules.html) provides more detailed information
about specific functions.
@@ -32,15 +32,15 @@ about specific functions.
There is a section on @ref guarantees_limitations for pointer lifetimes,
reentrancy, thread safety, event order and backward and forward compatibility.
The @ref vulkan guide fills in the gaps for how to use Vulkan with GLFW.
The @ref vulkan_guide guide fills in the gaps for how to use Vulkan with GLFW.
The @ref rift fills in the gaps for how to use LibOVR with GLFW.
The @ref rift_guide fills in the gaps for how to use LibOVR with GLFW.
The [FAQ](http://www.glfw.org/faq.html) answers many common questions about the
design, implementation and use of GLFW.
Finally, the @ref compat guide explains what APIs, standards and protocols GLFW
uses and what happens when they are not present on a given machine.
Finally, the @ref compat_guide guide explains what APIs, standards and protocols
GLFW uses and what happens when they are not present on a given machine.
This documentation was generated with Doxygen. The sources for it are available
in both the [source distribution](http://www.glfw.org/download.html) and