Gary Talent
60789230be
976550ef [nostalgia/sample_project] Add missing type descriptors 1fb0a866 [nostalgia/core] Fix CompactPalette TypeName and TypeVersion eb46aeeb [nfde] Fix compiler warnings on Gtk build 9244b735 [nostalgia] Fix non-Linux non-Apple systems not to build GLFW for Wayland 3fba36b4 [nfde] Make only option BUILD_SHARED_LIBS if not already set 6ddb6b42 Merge commit '5461f6700dac79e9e71e3966f8a1270706c385ba' 5461f670 Squashed 'deps/nfde/' changes from 28ade5a5c..5786fabce 1ecc7aa7 Merge commit '26c8cc348eacea01237cd64e1a68d0df8141e848' 26c8cc34 Squashed 'deps/glfw/' changes from 7d5a16ce7..7b6aead9f fc25c12d Merge commit 'ae51a422787bc3b720ff1748c0219c8f33363427' ae51a422 Squashed 'deps/imgui/' changes from f33737806..2db79d086 6c71e1e2 [nostalgia/core/studio,studio] Give TileSheetEditor Ctrl-A and Ctrl-G for selection 2ede01e7 [nostalgia/core/studio] Fix build deacd4ab [nostalgia/core/studio] Fix PaletteEditor add/remove color commands git-subtree-dir: deps/nostalgia git-subtree-split: 976550ef6fa269cf1e367e880f148b0ad7b1b163
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
# Introduction {#mainpage}
|
||
|
||
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.
|
||
|
||
@ref news list new features, caveats and deprecations.
|
||
|
||
@ref quick_guide is a guide for users new to GLFW. It takes you through how to
|
||
write a small but complete program.
|
||
|
||
There are guides for each section 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 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
|
||
|
||
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.
|
||
|
||
@ref moving_guide explains what has changed and how to update existing code to
|
||
use the new API.
|
||
|
||
There is a section on @ref guarantees_limitations for pointer lifetimes,
|
||
reentrancy, thread safety, event order and backward and forward compatibility.
|
||
|
||
Finally, @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](https://www.glfw.org/download.html) and
|
||
[GitHub repository](https://github.com/glfw/glfw).
|
||
|