implemented SUPER key/modifier support on windows
[freeglut] / README.win32
1 NB
2 ==================================
3 For ancient 16bit compatibility, windef.h (included through windows.h in
4 freeglut_std.h) defines near and far. Its best to avoid using variables
5 with these names in your own program.
6
7 Installing the Libraries with MSVC
8 ==================================
9
10 To install "freeglut" on your system so that your other projects will see it,
11 you will need to copy various files to various locations.
12
13     - The header files "freeglut.h", "freeglut_ext.h", "freeglut_std.h", and
14       "glut.h" (distributed in the directory "freeglut\freeglut\include\GL")
15       need to be copied to a "GL" directory under the MSVC include directory.
16       The MSVC include directory generally has a path similar to
17               "C:\Program Files\Microsoft Visual Studio\VC98\Include"
18       The "GL" subdirectory under that will probably already have the header
19       files "gl.h", "glaux.h", and "glu.h".
20     - The library file "freeglut.lib" or "freeglut_static.lib" (from the
21       corresponding debug or release directory) needs to be copied into the
22       MSVC library directory.  This usually has a path similar to:
23               "%ProgramFiles%\Microsoft SDKs\Windows\v7.0A\Lib" - x86 32 bits LIB's
24               "%ProgramFiles(x86)%\Microsoft SDKs\Windows\v7.0A\Lib" - x64 32 bits LIB's
25                           "%ProgramFiles(x86)%\Microsoft SDKs\Windows\v7.0A\Lib\x64" - x64 64 bits LIB's
26       Note that there is no "GL" subdirectory here.  This directory should
27       already have the files "opengl32.lib", "glu32.lib", and "glaux.lib".
28     - If you are using the DLL version of "freeglut", the file "freeglut.dll"
29       needs to be copied from the Debug or the Release directory into the
30       DLL directory.  This usually has a path similar to
31               "%SystemRoot%\System32\" - x86 32 bits DLL's
32                           "%SystemRoot%\SysWOW64\" - x64 32 bits DLL's
33                           "%SystemRoot%\System32\" - x64 64 bits DLL's
34       and will probably already have the files "opengl32.dll" and "glu32.dll".
35
36
37 Building and Installing the Libraries with Open Watcom
38 ======================================================
39
40 Start a command prompt and change directory to the freeglut installation
41 directory.  Type "wmake -f Makefile.wat all" to build the DLL and static
42 libraries in both debug and release versions.
43
44 To install "freeglut" on your system so that your other projects will see it,
45 you will need to copy various files to various locations.
46
47     - The header files "freeglut.h", "freeglut_ext.h", "freeglut_std.h", and
48       "glut.h" (distributed in the directory "freeglut\freeglut\include\GL")
49           need to be copied to a "GL" directory under the Open Watcom 32-bit
50           Windows include directory.  This usually has a path similar to
51                           "C:\WATCOM\h\nt\GL"
52     - The library file "freeglut.lib" or "freeglut_static.lib" (from the
53       corresponding debug or release directory) needs to be copied into the
54           Open Watcom 32-bit Windows library directory.  This usually has a path
55           similar to
56                           "C:\WATCOM\lib386\nt"
57     - If you are using the DLL version of "freeglut", the file "freeglut.dll"
58       needs to be copied from the Debug or the Release directory into the
59       DLL directory.  This usually has a path similar to
60               "C:\Windows\System32"
61       and will probably already have the files "opengl32.dll" and "glu32.dll".
62
63
64 Unlike the *nix release, the library names are NOT automatic replacements for
65 the GLUT library names.  You may rename them manually if you wish, but this is
66 not necessary as the header file includes a pragma telling the compiler which
67 library file to look for.
68
69
70 Building and Installing the Libraries with Cygwin
71 =================================================
72
73 To build "freeglut" under Cygwin, you have two choices:
74
75 - You can build a normal Cygwin library, which depends on Cygwin's X11
76   libraries. To do this, you can just use the normal autotools incantation:
77       ./configure && make install
78
79 - Alternatively, you can build a DLL which does not depend on X11 and links
80   against the opengl32 DLL. To do this, configure need a few more flags:
81       ./configure CPPFLAGS=-mno-cygwin LDFLAGS=-mno-cygwin --without-x && make install
82
83
84 If you don't have MSVC, Open Watcom or Cygwin
85 =============================================
86
87 The "freeglut" developers' community discussed the possibility of distributing
88 binaries and decided against it.  If you need Windows library files, please
89 contact John F. Fay at <john.fay@eglin.af.mil> or put a request on the
90 "freeglut" developers' mailing list <freeglut-developer@lists.sourceforge.net>.
91