Zengtudor
/
glfw
mirror of https://github.com/glfw/glfw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation work

This commit is contained in:
Camilla Löwy 2017-04-06 02:02:16 +02:00
parent 66b16f1fc1
commit 9457cf33d1
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/build.dox
View File

@ -243,6 +243,15 @@ target files generated when GLFW is installed.
find_package(glfw3 3.3 REQUIRED) find_package(glfw3 3.3 REQUIRED)
@endcode @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 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. 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 If your application calls OpenGL directly, instead of using a modern

4
docs/monitor.dox
View File

@ -195,8 +195,8 @@ glfwSetGammaRamp(monitor, &ramp);
The gamma ramp data is copied before the function returns, so there is no need 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. 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 It is recommended that your gamma ramp have the same size as the current gamma
supported by all graphics cards on all platforms. ramp for that monitor.
The current gamma ramp for a monitor is returned by @ref glfwGetGammaRamp. See The current gamma ramp for a monitor is returned by @ref glfwGetGammaRamp. See
the reference documentation for the lifetime of the returned structure. the reference documentation for the lifetime of the returned structure.