main.dox 1.8 KB

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