| 1 |
To install the OpenGL module, please follow these instructions: |
| 2 |
|
| 3 |
1. Update your development environment with the latest OpenGL header |
| 4 |
and lib files. If you are using a GPU, get the latest drivers |
| 5 |
from your vendor. |
| 6 |
|
| 7 |
Install FreeGLUT (or compatible) - you can find this at |
| 8 |
http://freeglut.sourceforge.net/. NOTE: Strawberry Perl |
| 9 |
includes the FreeGLUT library and the binary distributions |
| 10 |
at http://www.sisyphusion.tk provide the needed FreeGLUT |
| 11 |
as well. |
| 12 |
|
| 13 |
On 32-bit MS Windows, a binary FreeGLUT library is installed |
| 14 |
automatically by this module if needed. |
| 15 |
|
| 16 |
On Mac OS X (Leopard and newer), GLUT is available in the default |
| 17 |
OpenGL programming environment with sufficient extensions (added |
| 18 |
by Apple) to support full functionality. |
| 19 |
|
| 20 |
On most Linux distributions FreeGLUT is available via their |
| 21 |
package installers. |
| 22 |
|
| 23 |
The 'include' subfolder provided with this module contains |
| 24 |
headers that this module has been tested with. |
| 25 |
|
| 26 |
This module looks for libGL.so, libGLU.so and libglut.so |
| 27 |
(opengl32.dll, glu32.dll and freeglut.dll on Windows) in the normal |
| 28 |
places for your OS installation. You may need to symlink libraries |
| 29 |
from various vendors to the proper place/names. |
| 30 |
|
| 31 |
Note: If you will be installing OpenGL::Image, it is recommended, |
| 32 |
but not required, that you install PerlMagick (6.3.5 or newer) first, |
| 33 |
as this will dramatically simplify and enhance your ability/performance |
| 34 |
in loading/saving images/textures via OpenGL::Image - see INSTALL note |
| 35 |
in the OpenGL::Image module. |
| 36 |
|
| 37 |
|
| 38 |
2. Run 'perl Makefile.PL' |
| 39 |
|
| 40 |
Makefile.PL attempts to detemine your OS and available libs. |
| 41 |
|
| 42 |
You can override these defaults by specifying addiional |
| 43 |
options, shown in square brackets []: |
| 44 |
|
| 45 |
perl Makefile.PL [verbose] [interface=<XFACE>] [dist=<EXCLUSION SETTING>] |
| 46 |
|
| 47 |
The "verbose" option provides additional diagnostic output messages |
| 48 |
which can be helpful for troubleshooting and bug reports. |
| 49 |
|
| 50 |
For the "interface" option, <XFACE> is one of the following strings: |
| 51 |
|
| 52 |
FREEGLUT Default window interface |
| 53 |
GLUT Fallback if FreeGLUT is not available |
| 54 |
AGL GLUT framework on Mac OS X |
| 55 |
GLX Legacy X11+GLX, use FreeGLUT instead |
| 56 |
W32API FreeGLUT and W32API OpenGL on CYGWIN |
| 57 |
WGL Same as W32API |
| 58 |
|
| 59 |
Specifying the interface directly should not be needed except |
| 60 |
where there is some ambiguity in the available interfaces (i.e. |
| 61 |
you have FreeGLUT, GLUT, and GLX on your system). If you have |
| 62 |
FreeGLUT and OpenGL installed, it should just work with the defaults. |
| 63 |
|
| 64 |
*Please* let us know if it doesn't. |
| 65 |
|
| 66 |
Makefile.PL will attempt to build and run a glversion utility to |
| 67 |
determine what version and extensions your OpenGL installation |
| 68 |
supports, and will create an gl_exclude.h header file to exclude |
| 69 |
APIs your libraries do not support. You can manually edit this |
| 70 |
file to override excluded extensions. |
| 71 |
|
| 72 |
|
| 73 |
Note: glversion assumes libGL.so and libglut.so |
| 74 |
(opengl32.dll and freeglut.dll on Windows) - and that it will |
| 75 |
be run via a GUI window (eg. X11 on Unix). This may impact |
| 76 |
automated build systems. |
| 77 |
|
| 78 |
|
| 79 |
For building POGL without extension exclusions, use: |
| 80 |
|
| 81 |
perl Makefile.PL dist=NO_EXCLUSIONS |
| 82 |
|
| 83 |
Note: NO_EXCLUSIONS is the default for Windows; this can be |
| 84 |
overridden by using the EXCLUSIONS option. |
| 85 |
|
| 86 |
|
| 87 |
To install in non-standard locations, use the INSTALL_BASE option |
| 88 |
when generating the Makefiles: |
| 89 |
|
| 90 |
perl Makefile.PL INSTALL_BASE=BASEPATH |
| 91 |
|
| 92 |
where BASEPATH is the path of the directory where you wish |
| 93 |
the module to be installed (e.g. binary executables in BASEPATH/bin, |
| 94 |
manual pages in BASEPATH/man, library files in BASEPATH/lib/perl5). |
| 95 |
|
| 96 |
Then either set the PERL5LIB environment variable before you run |
| 97 |
scripts that use the modules/libraries (see perlrun) or in your |
| 98 |
programs say: |
| 99 |
|
| 100 |
use lib 'BASEPATH/lib/perl5'; |
| 101 |
|
| 102 |
|
| 103 |
3. Run 'make' ('nmake' on Windows, 'dmake' on MinGW) to build OpenGL. |
| 104 |
|
| 105 |
|
| 106 |
4. Run 'make test' ('nmake test' on Windows, 'dmake test' on MinGW) to |
| 107 |
test your installation. You must have GLUT installed in order to run |
| 108 |
this test. You should see a spinning cube with textured surfaces. |
| 109 |
Press 'q' to quit/complete the test (the test window must have focus). |
| 110 |
|
| 111 |
Note: Automated builds will normally fail this test, as it requires |
| 112 |
the ability to open a GL context (window) and provide user input. |
| 113 |
|
| 114 |
|
| 115 |
5. If all is well, run 'sudo make install' ('nmake install on Windows', |
| 116 |
and 'dmake install' with MinGW) to intall the OpenGL module onto |
| 117 |
your system. |
| 118 |
|
| 119 |
|
| 120 |
6. It is recommended (though not required) that you also install the |
| 121 |
OpenGL::Image and OpenGL::Shader modules to enhance POGL's features. |
| 122 |
|
| 123 |
|
| 124 |
Read the included README files for additional notes on your particular |
| 125 |
platform. |