From 9457cf33d1db8bc604ac5a258c0406c7cf5b9ae0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Thu, 6 Apr 2017 02:02:16 +0200 Subject: [PATCH] Documentation work --- docs/build.dox | 9 +++++++++ docs/monitor.dox | 4 ++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/build.dox b/docs/build.dox index a3c62885..97dda32d 100644 --- a/docs/build.dox +++ b/docs/build.dox @@ -243,6 +243,15 @@ target files generated when GLFW is installed. find_package(glfw3 3.3 REQUIRED) @endcode +Once GLFW has been added to the project, link against it with the `glfw` target. +This adds all link-time dependencies of GLFW as it is currently configured, +the include directory for the GLFW header and, when applicable, the @ref +GLFW_DLL macro. + +@code{.cmake} +target_link_libraries(myapp glfw) +@endcode + Note that the dependencies do not include OpenGL or GLU, as GLFW loads any OpenGL, OpenGL ES or Vulkan libraries it needs at runtime and does not use GLU. If your application calls OpenGL directly, instead of using a modern diff --git a/docs/monitor.dox b/docs/monitor.dox index ee9fced1..708461f5 100644 --- a/docs/monitor.dox +++ b/docs/monitor.dox @@ -195,8 +195,8 @@ glfwSetGammaRamp(monitor, &ramp); The gamma ramp data is copied before the function returns, so there is no need to keep it around once the ramp has been set. -@note It is recommended to use gamma ramps of size 256, as that is the size -supported by all graphics cards on all platforms. +It is recommended that your gamma ramp have the same size as the current gamma +ramp for that monitor. The current gamma ramp for a monitor is returned by @ref glfwGetGammaRamp. See the reference documentation for the lifetime of the returned structure.