1/*!
2
3@mainpage notitle
4
5@section main_intro Introduction
6
7GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and
8Vulkan application development.  It provides a simple, platform-independent API
9for creating windows, contexts and surfaces, reading input, handling events, etc.
10
11@ref news_33 list new features, caveats and deprecations.
12
13@ref quick_guide is a guide for users new to GLFW.  It takes you through how to
14write a small but complete program.
15
16There are guides for each section of the API:
17
18 - @ref intro_guide – initialization, error handling and high-level design
19 - @ref window_guide – creating and working with windows and framebuffers
20 - @ref context_guide – working with OpenGL and OpenGL ES contexts
21 - @ref vulkan_guide - working with Vulkan objects and extensions
22 - @ref monitor_guide – enumerating and working with monitors and video modes
23 - @ref input_guide – receiving events, polling and processing input
24
25Once you have written a program, see @ref compile_guide and @ref build_guide.
26
27The [reference documentation](modules.html) provides more detailed information
28about specific functions.
29
30@ref moving_guide explains what has changed and how to update existing code to
31use the new API.
32
33There is a section on @ref guarantees_limitations for pointer lifetimes,
34reentrancy, thread safety, event order and backward and forward compatibility.
35
36The [FAQ](https://www.glfw.org/faq.html) answers many common questions about the
37design, implementation and use of GLFW.
38
39Finally, @ref compat_guide explains what APIs, standards and protocols GLFW uses
40and what happens when they are not present on a given machine.
41
42This documentation was generated with Doxygen.  The sources for it are available
43in both the [source distribution](https://www.glfw.org/download.html) and
44[GitHub repository](https://github.com/glfw/glfw).
45
46*/
47