glfw/docs/main.dox
2016-02-19 10:38:30 +01:00

50 lines
2.0 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*!
@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_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_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 @ref compile_guide and @ref build_guide.
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 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.
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.
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).
*/