You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and dots ('.'), can be up to 35 characters long. Letters must be lowercase.
49 lines
2.0 KiB
49 lines
2.0 KiB
/*! |
|
|
|
@mainpage notitle |
|
|
|
@section main_intro Introduction |
|
|
|
GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and |
|
Vulkan application development. It provides a simple, platform-independent API |
|
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. |
|
|
|
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 |
|
|
|
Once you have written a program, see the @ref compile and @ref build guides. |
|
|
|
The [reference documentation](modules.html) provides more detailed information |
|
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 rift 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. |
|
|
|
This documentation was generated with Doxygen. The sources for it are available |
|
in both the [source distribution](http://www.glfw.org/download.html) and |
|
[GitHub repository](https://github.com/glfw/glfw). |
|
|
|
*/
|
|
|