glfw/docs/main.md

44 lines
1.8 KiB
Markdown
Raw Normal View History

@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.
2019-04-16 12:43:29 +00:00
@ref news_34 list new features, caveats and deprecations.
2016-02-19 09:42:28 +00:00
@ref quick_guide is a guide for users new to GLFW. It takes you through how to
write a small but complete program.
2013-03-29 13:06:23 +00:00
2016-02-19 09:42:28 +00:00
There are guides for each section of the API:
2014-09-18 13:03:29 +00:00
- @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
2016-02-19 09:42:28 +00:00
- @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
2014-09-18 13:03:29 +00:00
Once you have written a program, see @ref compile_guide and @ref build_guide.
2014-09-18 13:03:29 +00:00
The [reference documentation](modules.html) provides more detailed information
about specific functions.
2016-02-19 09:42:28 +00:00
@ref moving_guide explains what has changed and how to update existing code to
use the new API.
2015-01-18 00:55:25 +00:00
There is a section on @ref guarantees_limitations for pointer lifetimes,
reentrancy, thread safety, event order and backward and forward compatibility.
2018-11-02 19:55:02 +00:00
The [FAQ](https://www.glfw.org/faq.html) answers many common questions about the
2015-01-18 00:55:25 +00:00
design, implementation and use of GLFW.
2014-09-18 13:03:29 +00:00
2016-02-19 09:42:28 +00:00
Finally, @ref compat_guide explains what APIs, standards and protocols GLFW uses
and what happens when they are not present on a given machine.
2014-09-18 13:03:29 +00:00
This documentation was generated with Doxygen. The sources for it are available
2018-11-02 19:55:02 +00:00
in both the [source distribution](https://www.glfw.org/download.html) and
2014-09-18 13:03:29 +00:00
[GitHub repository](https://github.com/glfw/glfw).
2013-03-29 13:06:23 +00:00