From be65829055373bb79243e971c1104b92201e23f6 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Mon, 12 Oct 2015 19:04:09 +0200 Subject: [PATCH] Clarify GLU deprecation --- docs/build.dox | 9 +++++---- docs/moving.dox | 2 +- docs/quick.dox | 5 +++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/build.dox b/docs/build.dox index aa6c5fe8..d14cf799 100644 --- a/docs/build.dox +++ b/docs/build.dox @@ -96,8 +96,8 @@ to that header. `GLFW_INCLUDE_GLU` makes the header include the GLU header in addition to the header selected above. This should only be used with the standard OpenGL header -and only for legacy code. GLU has been deprecated and should not be used in new -code. +and only for compatibility with legacy code. GLU has been deprecated and should +not be used in new code. @note GLFW does not provide any of the API headers mentioned above. They must be provided by your development environment or your OpenGL or OpenGL ES SDK. @@ -254,7 +254,7 @@ You can also use the `glfw3.pc` file without installing it first, by using the env PKG_CONFIG_PATH=path/to/glfw/src cc `pkg-config --cflags glfw3` -o myprog myprog.c `pkg-config --libs glfw3` @endcode -The dependencies do not include GLU, as GLFW does not need it. On OS X, GLU is +The dependencies do not include GLU, as GLFW does not use it. On OS X, GLU is built into the OpenGL framework, so if you need GLU you don't need to do anything extra. If you need GLU and are using Linux or BSD, you should add the `glu` pkg-config module. @@ -263,7 +263,8 @@ anything extra. If you need GLU and are using Linux or BSD, you should add the cc `pkg-config --cflags glfw3 glu` -o myprog myprog.c `pkg-config --libs glfw3 glu` @endcode -If you are using the static version of the GLFW library, make sure you don't link statically against GLU. +If you are using the static version of the GLFW library, make sure you don't +link statically against GLU. @code{.sh} cc `pkg-config --cflags glfw3 glu` -o myprog myprog.c `pkg-config --static --libs glfw3` `pkg-config --libs glu` diff --git a/docs/moving.dox b/docs/moving.dox index 0e7ed5e3..95aa3559 100644 --- a/docs/moving.dox +++ b/docs/moving.dox @@ -429,7 +429,7 @@ invalidating any window handles you may still have. GLFW 3 does not by default include the GLU header and GLU itself has been deprecated by [Khronos](https://en.wikipedia.org/wiki/Khronos_Group). __New -projects should avoid using GLU__, but if you need to compile legacy code that +projects should not use GLU__, but if you need it for legacy code that has been moved to GLFW 3, you can request that the GLFW header includes it by defining `GLFW_INCLUDE_GLU` before the inclusion of the GLFW header. diff --git a/docs/quick.dox b/docs/quick.dox index 12283a15..af56c629 100644 --- a/docs/quick.dox +++ b/docs/quick.dox @@ -47,8 +47,9 @@ In other words: GLFW one and it will detect this Starting with version 3.0, the GLU header `glu.h` is no longer included by -default. If you wish to include it, define `GLFW_INCLUDE_GLU` before the -inclusion of the GLFW header. +default. GLU is deprecated and should not be used in new code. If you need to +include it for legacy code, define `GLFW_INCLUDE_GLU` before the inclusion of +the GLFW header. @code #define GLFW_INCLUDE_GLU