Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-22 18:15:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify GLU deprecation

Browse Source
This commit is contained in:
Camilla Berglund 2015-10-12 19:04:09 +02:00
parent e0084617d5
commit be65829055
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/build.dox
View File

@ -96,8 +96,8 @@ to that header.
`GLFW_INCLUDE_GLU` makes the header include the GLU header in addition to the `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 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 and only for compatibility with legacy code. GLU has been deprecated and should
code. not be used in new code.
@note GLFW does not provide any of the API headers mentioned above. They must @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. 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` env PKG_CONFIG_PATH=path/to/glfw/src cc `pkg-config --cflags glfw3` -o myprog myprog.c `pkg-config --libs glfw3`
@endcode @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 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 anything extra. If you need GLU and are using Linux or BSD, you should add the
`glu` pkg-config module. `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` cc `pkg-config --cflags glfw3 glu` -o myprog myprog.c `pkg-config --libs glfw3 glu`
@endcode @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} @code{.sh}
cc `pkg-config --cflags glfw3 glu` -o myprog myprog.c `pkg-config --static --libs glfw3` `pkg-config --libs glu` cc `pkg-config --cflags glfw3 glu` -o myprog myprog.c `pkg-config --static --libs glfw3` `pkg-config --libs glu`

2
docs/moving.dox
View File

@ -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 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 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 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. defining `GLFW_INCLUDE_GLU` before the inclusion of the GLFW header.

5
docs/quick.dox
View File

@ -47,8 +47,9 @@ In other words:
GLFW one and it will detect this GLFW one and it will detect this
Starting with version 3.0, the GLU header `glu.h` is no longer included by 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 default. GLU is deprecated and should not be used in new code. If you need to
inclusion of the GLFW header. include it for legacy code, define `GLFW_INCLUDE_GLU` before the inclusion of
the GLFW header.
@code @code
#define GLFW_INCLUDE_GLU #define GLFW_INCLUDE_GLU