mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-25 22:14:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation main page

Browse Source
This commit is contained in:
Camilla Berglund 2016-02-19 10:42:28 +01:00
parent 80c203f3bb
commit cbcadded18
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/main.dox
View File

@ -11,16 +11,15 @@ 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_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.
@ref quick_guide is a guide for users new to GLFW. It takes you through how to
write a small but complete program.
There are guides for each of the various areas of the API.
There are guides for each section of the API:
- @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 vulkan_guide - working with Vulkan objects and extensions
- @ref monitor_guide – enumerating and working with monitors and video modes
- @ref input_guide – receiving events, polling and processing input
@ -29,18 +28,19 @@ 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.
@ref moving_guide explains what has changed and how to update existing code to
use the new API.
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 guide fills in the gaps for how to use Vulkan with GLFW.
The @ref rift_guide fills in the gaps for how to use LibOVR with GLFW.
@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 guide explains what APIs, standards and protocols
GLFW uses and what happens when they are not present on a given machine.
Finally, @ref compat_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

2
docs/rift.dox
View File

@ -1,6 +1,6 @@
/*!
@page rift_guide Oculus Rift guide
@page rift_guide Using GLFW with LibOVR
@tableofcontents