Home My Page Projects Code Snippets Project Openings 3D graphics for Standard ML
Summary Activity SCM

SCM Repository

[sml3d] Diff of /trunk/sml3d/README
ViewVC logotype

Diff of /trunk/sml3d/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 138, Thu May 29 18:30:16 2008 UTC revision 139, Fri May 30 16:47:02 2008 UTC
# Line 1  Line 1 
1  Various libraries designed to support real-time 3D programming  SUMMARY
2  in SML.    A suite of libraries to support real-time 3D programming in SML using OpenGL.
3    
4    INSTALLATION
5      This library requires the MLton SML compiler (mlton.org).  Because of
6      a bug in handling of 8-bit signed integers, it does not build using
7      the 20070826 release, but will build under the latest version from svn.
8    
9      After unpacking, run the configure script and then make.  You can then
10      try out some of the example programs.
11    
12    USAGE
13    
14      Depending on which components of the SML3D library you are using, you
15      will need to pass additional flags to the mlton commmand line.  We
16      have packaged up this behavior in a shell script (bin/config-cmd.sh).
17      Thus, you can invoke mlton as follows
18    
19            mlton `config-sml3d.sh components` project.mlb
20    
21      where "project.mlb" is your project's MLB file.  The argument to the
22      script specifies which components your project is using.  The values
23      are:
24            no-opengl       Do not use OpenGL support (incompatable with glut
25                            option)        glut            Use the GLUT library        sdl             Use SDL (incompatable with GLUT)        sdl-ttf         Use the SDL True-type font library (implies sdl
26                            option)        sdl-image       Use the SDL True-type font library (implies sdl
27                            option)        sdl-mixer       Use the SDL audio mixer library (implies sdl
28                            option)        openal          Use the OpenAL library (incompatable with sdl-mixer)        devil           Use the DevIL image library
29    
30      If you use GNU make to build your project, you may want to include the
31      mk/config.gmk file in your makefile.  Define the SML3D_CONFIG_OPTIONS make
32      variable to the components that you are using and use the MLTON_FLAGS
33      variable as an argument to the mlton command.
34    
35    ROADMAP
36    
37          doc/          doc/
38          src/          src/
39            util          - SML code for vectors, matrices, etc.            common        - SML code for vectors, matrices, etc.
40            opengl        - SML interfaces to the GL and GLU libraries            devil         - support for image I/O based on DevIL
41            glut          - SML interface to the GLUT library            glut          - SML interface to the GLUT library
42            gui           - A simple, GLUT-based, GUI library            gui           - A simple, GLUT-based, GUI library
43              image         - basic image support
44              loaders       - loaders for some 3D file formats
45              openal        - SML interfaces to OpenAL
46              opengl        - SML interfaces to the GL and GLU libraries
47            particles     - A library for particle effects.            particles     - A library for particle effects.
48              sdl           - SML interfaces to SDL and related libraries
49              tests         - test programs
50              util          - various utility modules
51          examples/       - some example programs          examples/       - some example programs
52    
53  TODO:  TODO:
# Line 15  Line 55 
55          model loaders (obj and mtl files)          model loaders (obj and mtl files)
56          SDL          SDL
57    
58  This software is Copyright (c) 2005 John Reppy (All rights reserved).  It is  This software is Copyright (c) 2008 John Reppy (All rights reserved).  It is
59  distributed under the GNU GENERAL PUBLIC LICENSE (Version 2).  See the COPYING  distributed under the GNU GENERAL PUBLIC LICENSE (Version 2).  See the COPYING
60  file for details.  file for details.
   

Legend:
Removed from v.138  
changed lines
  Added in v.139

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0