Contents.txt
August 3, 1998

Folder                    File, Folder or Disk Description                        
------------------------- -------------------- ---------------------------------- 
\                         Doc                  Documentation: Soft-copy           
                                               versions of programming            
                                               references and guides.             
\                         Lib                  Libraries: 2-D and 3-D             
                                               graphics, filesystem,              
                                               and I/O.                           
\                         Utl                  Utilities: Debugging,              
                                               GD-ROM simulation tools,           
                                               debug system testing, 2-D          
                                               and 3-D art conversion             
                                               and processing.                    
\                         Install.txt          Instructions for installing the    
                                               development hardware and           
                                               software.  Follow these            
                                               instructions after reading         
                                               readme.txt.                        
\                         Legal.txt            Legal copyright and                
                                               disclaimer information.            
\                         Readme.txt           Readme: read these                 
                                               instructions before                
                                               attempting to use                  
                                               this hardware and                  
                                               software!                          
\Doc                      PDFs                 Adobe Acrobat files                
                                               containing soft-copy               
                                               versions of all                    
                                               documentation.                     
\Doc                      Index.pdf            Documentation root.                
                                               Open this file to browse           
                                               all documentation.                 
\Doc                      rs32e301.exe         Adobe Acrobat with Search,         
                                               version 3.01.  Allows you          
                                               to search across the               
                                               contents of multiple               
                                               documents.                         
\Lib                      Kamui                C include files and sample         
                                               programs for Kamui, a low-         
                                               level graphics API.                
\Lib                      Libc                 Basic libc-type support.           
                                               Contains libcross, which           
                                               supports standard I/O              
                                               calls.  N.B. Libcross              
                                               is not compatible with             
                                               the Shinobi series                 
                                               of functions.                      
\Lib                      Ninja                Includes, libraries, and           
                                               sample programs for                
                                               Ninja, a medium- to high-          
                                               level graphics API.                
\Lib                      Shinobi              Shinobi: library support           
                                               for the file system,               
                                               peripherals, and memory            
                                               management.                        
\Lib                      SetPaths.bat         Prepares a DOS environment         
                                               for building the sample            
                                               programs in these                  
                                               directories.  It checks            
                                               for the existence of               
                                               nmake, the Hitachi                 
                                               libraries and tools, and           
                                               sets necessary environment         
                                               variables.                         
\Lib\Kamui                Include              C include files for                
                                               Kamui.                             
\Lib\Kamui                Samples              Sample programs that you           
                                               can compile, modify and run        
                                               that use the Kamui API.            
\Lib\Kamui\Samples        Modtest01            Sample application demonstrating   
                                               moving two textures across two     
                                               modifier surfaces.                 
\Lib\Kamui\Samples        QuikTest             Sample application that            
                                               demonstrates some                  
                                               useful Kamui optimizations.        
\Lib\Kamui\Samples        Reload01             Sample application that            
                                               loads and displays one             
                                               texture applied to nine            
                                               different mipmap sizes.            
\Lib\Kamui\Samples        Rendtx02             Sample application that            
                                               shows how to render flat           
                                               textures into a display            
                                               buffer, and then use               
                                               the rendered buffer as             
                                               a texture in a multipass           
                                               rendering.                         
\Lib\Kamui\Samples        Rendtx03             Sample application demonstrating   
                                               use of back planes for generating  
                                               motion blur effects.  This sample  
                                               also demonstrates using the frame  
                                               buffer as a texture.               
\Lib\Kamui\Samples        SbTest               Sample program that                
                                               demonstrates simultaneous          
                                               peripheral access, file            
                                               access, and memory                 
                                               allocation.                        
\Lib\Kamui\Samples        Txtest01             Sample application that renders    
                                               textures from twiddled ARGB4444,   
                                               ARGB1555, and RGB565 formats.      
                                               The textures are resized with and  
                                               without clamping of u and v        
                                               coordinates.                       
\Lib\Kamui\Samples        Txtest02             Sample application that renders    
                                               textures from twiddled ARGB4444,   
                                               ARGB1555, and RGB565 formats.      
                                               These textures are mipmapped.      
                                               The textures are resized with and  
                                               without clamping of u and v        
                                               coordinates.                       
\Lib\Kamui\Samples        Txtest03             Sample application that renders    
                                               textures from vector-quantization  
                                               (VQ) compressed textures.  A       
                                               texture is rendered in ARGB1555    
                                               mode against a filled background.  
\Lib\Kamui\Samples        Txtest05             Sample application that shows      
                                               how to render a rectangular        
                                               texture.  This texture is in       
                                               ARGB4444 format and has            
                                               texel size 128x32; however, it     
                                               is displayed as a scaling square.  
\Lib\Kamui\Samples        _.bat                Sets environmental                 
                                               variables before running           
                                               an nmake.  Do not run              
                                               this file directly; instead,       
                                               run make.bat.                      
\Lib\Kamui\Samples        katana.inc           The default set of make rules      
                                               for making all Ninja projects      
                                               under Microsoft Visual C++.        
                                               This make occurs via the           
                                               command line.                      
\Lib\Kamui\Samples        Make.bat             Run this batch file to build       
                                               all examples in subdirectories     
                                               of this directory.  Visual C++     
                                               5.0 must be installed.             
\Lib\Kamui\Samples        makefile             nmake-format makefile that         
                                               makes all the Kamui examples       
                                               in these subdirectories.           
\Lib\Libc                 Include              Include files for the              
                                               libc set of libraries.             
\Lib\Libc                 Lib                  Library files for the              
                                               libc set of libraries,             
                                               which includes the                 
                                               libcross I/O                       
                                               implementation.                    
                                               Is not compatible                  
                                               with Shinobi.                      
\Lib\Libc                 Samples              An example program                 
                                               showing console                    
                                               output on Katana.                  
\Lib\Libc\Samples         Hello                Prints output to the               
                                               console, creates a 4 MB            
                                               data file in the Codescape         
                                               directory, writes to it,           
                                               and reads from it.                 
\Lib\Libc\Samples         _.bat                Sets environmental                 
                                               variables before running           
                                               an nmake.  Do not run              
                                               this file directly; instead,       
                                               run make.bat.                      
\Lib\Libc\Samples         Make.bat             Run this batch file to build       
                                               all examples in subdirectories     
                                               of this directory.  Visual C++     
                                               5.0 must be installed.             
\Lib\Ninja                Include              C include files required           
                                               by Ninja applications.             
\Lib\Ninja                Lib                  Library files required by          
                                               Ninja applications.                
\Lib\Ninja                Samples              Sample programs for use            
                                               with Ninja.                        
\Lib\Ninja\Samples        cpp_tea              Sample application, teapot,        
                                               modified slightly to be            
                                               compilable with the                
                                               prototype C++ compiler.            
                                               Does not use any heavy-            
                                               duty C++ functionality.            
\Lib\Ninja\Samples        Draw2D               Sample application which shows     
                                               drawing 2-D objects with Ninja.    
                                               Allows the user to draw points,    
                                               lines, polygon, and circles.       
\Lib\Ninja\Samples        Draw3D               Sample application that shows      
                                               several Ninja 3-D primitives       
                                               and models rendered in             
                                               several modes.  Models are         
                                               rendered with and without          
                                               textures, in wireframe,            
                                               and with and without depth         
                                               fogging.                           
\Lib\Ninja\Samples        f40                  Sample application that            
                                               spins a Ferrari on the             
                                               display.                           
\Lib\Ninja\Samples        future               Sample application showing         
                                               a relatively complex world,        
                                               with spaceship, weapons,           
                                               and enemy AI.  Uses the            
                                               Maple control pad interface        
                                               via Shinobi.                       
\Lib\Ninja\Samples        Light                Sample application that            
                                               demonstrates how to manage         
                                               multiple (in this case, six) light 
                                               sources in a scene.  Each light    
                                               source can be turned on or off     
                                               and the color of each light        
                                               source can be changed in           
                                               real-time.                         
\Lib\Ninja\Samples        Logo                 Sample application that shows      
                                               how to use Ninja for               
                                               environmental mapping.             
\Lib\Ninja\Samples        Motlink              Sample application that            
                                               shows how to create                
                                               an object hierarchy                
                                               and animate that                   
                                               hierarchy using either             
                                               linear or spline based             
                                               animation.                         
\Lib\Ninja\Samples        print                Reads the Maple                    
                                               controller and prints the          
                                               raw controller information         
                                               to the screen.                     
\Lib\Ninja\Samples        sg_gd                Tests the GD-ROM file              
                                               system using subdirectories.       
\Lib\Ninja\Samples        sg_gd2               Tests the GD-ROM file              
                                               system using a large               
                                               file.                              
\Lib\Ninja\Samples        Shape                Sample application that            
                                               demonstrates the use of            
                                               njDrawShapeMotion()                
                                               to animate a model.                
\Lib\Ninja\Samples        Simple               Simplest Ninja example:            
                                               rotates a cube while               
                                               accessing the control              
                                               pad.                               
\Lib\Ninja\Samples        Teapot               Sample application shows the       
                                               classic Utah teapot, this time     
                                               with a material and specular       
                                               highlights.                        
\Lib\Ninja\Samples        Temjin               Sample application showing         
                                               hierarchical animation technique   
                                               using Ninja.  This application     
                                               also reuses the frame buffer       
                                               for a hall-of-mirrors effect.      
\Lib\Ninja\Samples        _.bat                Sets environmental                 
                                               variables before running           
                                               an nmake.  Do not run              
                                               this file directly; instead,       
                                               run make.bat.                      
\Lib\Ninja\Samples        katana.inc           The default set of make rules      
                                               for making all Ninja projects      
                                               under Microsoft Visual C++.        
                                               This make occurs via the           
                                               command line.                      
\Lib\Ninja\Samples        Make.bat             Run this batch file to set         
                                               paths correctly before             
                                               executing the recursive            
                                               make.                              
\Lib\Shinobi              Include              Include files for Shinobi,         
                                               a filesystem API.                  
\Lib\Shinobi              Lib                  Linkable libraries for             
                                               Shinobi, a filesystem              
                                               API.                               
\Utl                      Dev                  Development software:              
                                               compiler, linker, assembler,       
                                               debugger, debug adapter            
                                               checker.                           
\Utl                      Gfx                  2-D and 3-D graphics               
                                               conversion and processing          
                                               utilities.                         
\Utl\Dev                  Codescape            Codescape: a source-level          
                                               debugger and profiler.             
\Utl\Dev                  DACheck              Debug Adapter Checker:             
                                               verifies the performance           
                                               of your development                
                                               system.                            
\Utl\Dev                  GDWorkshop           GD Workshop: emulates              
                                               the performance of the             
                                               GD-ROM filesystem.                 
\Utl\Dev                  Hitachi              Hitachi command-line               
                                               compilation tools.                 
\Utl\Dev\Codescape        Build92.doc          Revision history for               
                                               Codescape.                         
\Utl\Dev\Codescape        C.ini                Codescape initialization           
                                               file; describes keywords           
                                               and display locations.             
\Utl\Dev\Codescape        Codescap.spl         Splash screen.                     
\Utl\Dev\Codescape        codescape.exe        CodeScape source-level             
                                               debugger, build 88.                
\Utl\Dev\Codescape        Cs11_aa.cnt          Topic index for Codescape          
                                               help file.                         
\Utl\Dev\Codescape        Cs11_aa.hlp          Codescape help file.               
\Utl\Dev\Codescape        Dali.cfg             Codescape configuration            
                                               for defining areas of              
                                               memory that are                    
                                               user-readable.                     
\Utl\Dev\Codescape        Datool.doc           Documentation for                  
                                               DATool, in Microsoft               
                                               Word format.                       
\Utl\Dev\Codescape        Datool.exe           Allow simple upload                
                                               and download to and                
                                               from target.  Commands             
                                               can be supplied on                 
                                               the command line.                  
\Utl\Dev\Codescape        Default.ini          Codescape initialization           
                                               file; describes keywords           
                                               only.                              
\Utl\Dev\Codescape        Genie.fsh            Debug adapter flash                
                                               ROM file, version                  
                                               3.4.0a.  Used with                 
                                               DACheck to update                  
                                               the flash ROMs in                  
                                               your development                   
                                               system.                            
\Utl\Dev\Codescape        History.txt          Revision history.                  
\Utl\Dev\DACheck          DAcheck.cnt          Topic index for on-line            
                                               help file.                         
\Utl\Dev\DACheck          DAcheck.exe          Debug Adapter checker              
                                               version 1.3.  Downloads            
                                               flash ROM images to                
                                               target development                 
                                               system and tests the               
                                               system.                            
\Utl\Dev\DACheck          Dacheck.hlp          On-line help file.                 
\Utl\Dev\GDWorkshop       cpmw.doc             Documentation for                  
                                               command-line GD                    
                                               Workshop builder.                  
\Utl\Dev\GDWorkshop       cpmw.exe             Command-line version               
                                               of GD Workshop; can                
                                               be integrated into                 
                                               command-line builds.               
\Utl\Dev\GDWorkshop       GDWorks.cnt          Help index file.                   
\Utl\Dev\GDWorkshop       Gdworks.hlp          On-line help file.                 
\Utl\Dev\GDWorkshop       GDWorkshop.dib       Startup logo.                      
\Utl\Dev\GDWorkshop       GDWorkshop.exe       GD Workshop version                
                                               2.3.17a.  GD-ROM filesystem        
                                               performance emulator               
                                               and layout controller.             
\Utl\Dev\GDWorkshop       gm2_3_9k.fsh         GD Workshop flash                  
                                               ROM file, version 2.3.9a.          
                                               Use the DACheck utility            
                                               to download this                   
                                               flash ROM file to the              
                                               GD-ROM emulator.                   
\Utl\Dev\GDWorkshop       history.txt          Revision history.                  
\Utl\Dev\GDWorkshop       Release.doc          Bugs recently fixed                
                                               in GD Workshop.                    
\Utl\Dev\GDWorkshop       Test.dat             A large file that you can          
                                               use to satisfy GD                  
                                               Workshop's requirement             
                                               of four seconds of data            
                                               per track.  (Four seconds          
                                               of white noise at 44 KHz,          
                                               16 bit stereo.)                    
\Utl\Dev\Hitachi          asmsh.exe            SH Series assembler                
\Utl\Dev\Hitachi          cnvs.exe             SH Series SYSROF to                
                                               STYPE object converter.            
                                               Used after the link                
                                               process to strip ELF               
                                               information from the               
                                               linked file.  This tool            
                                               takes ELF input                    
                                               and produces                       
                                               .MOT output.                       
\Utl\Dev\Hitachi          dwfcnv.exe           DWARF absolute-object              
                                               file converter.  Takes the         
                                               SYSROF object file and             
                                               outputs a DWARF (DWF)              
                                               file, containing debugging         
                                               information, and an object         
                                               file (0).                          
\Utl\Dev\Hitachi          elfcnv.exe           SYSROF -> ELF/DWARF                
                                               conversion tool.  Not used         
                                               in our current make                
                                               process.                           
\Utl\Dev\Hitachi          lbr.exe              H Series object librarian.         
                                               Operates on .OBJ/.O files          
                                               as linkable functions,             
                                               and .LIB files as libraries.       
\Utl\Dev\Hitachi          lnk.exe              H Series linker.  Takes            
                                               SYSROF format files                
                                               as input and produces an           
                                               ELF.                               
\Utl\Dev\Hitachi          rof2bin.exe          Strips the SYSROF header           
                                               from a compiled segment            
                                               of code to produce a               
                                               BIN file.                          
\Utl\Dev\Hitachi          s2bin.exe            Takes a MOT file as input          
                                               and produces a BIN file            
                                               as output.  Used as a final        
                                               step in the make process           
                                               if no debugging information        
                                               is generated.                      
\Utl\Dev\Hitachi          shc.exe              Hitachi SH-C compiler              
                                               launcher.                          
\Utl\Dev\Hitachi          shcasm.exe           Hitachi SH-C/C++                   
                                               assembler component.               
\Utl\Dev\Hitachi          shcerr.msg           Error messages and                 
                                               descriptions generated             
                                               by the C compiler.                 
\Utl\Dev\Hitachi          shcerr.off           Error numbers and offsets          
                                               into the appropriate .MSG          
                                               files.                             
\Utl\Dev\Hitachi          shcfrt.exe           Hitachi SH-C frontend.             
                                               Executes f step of                 
                                               compiler.                          
\Utl\Dev\Hitachi          shcgen.exe           Hitachi SH-C compiler              
                                               code generator, stage              
                                               C.                                 
\Utl\Dev\Hitachi          shchlp.msg           C compiler help message.           
\Utl\Dev\Hitachi          shcmdl.exe           Hitachi SH-C compiler,             
                                               optimization phase.                
\Utl\Dev\Hitachi          shcpep.exe           Hitachi SH-C compiler,             
                                               code generation stage              
                                               P.                                 
\Utl\Dev\Hitachi          shcpp.exe            Hitachi SH-C++ launcher.           
                                               Not feature complete.              
\Utl\Dev\Hitachi          shcpperr.msg         Error messages and codes           
                                               generated by the C++               
                                               compiler.                          
\Utl\Dev\Hitachi          shcpperr.off         Error numbers and offsets          
                                               into the appropriate .MSG          
                                               files.                             
\Utl\Dev\Hitachi          shcppfrt.exe         Hitachi SH-C++ frontend.           
\Utl\Dev\Hitachi          shcpphlp.msg         C++ compiler help                  
                                               message.                           
\Utl\Dev\Hitachi          shcprep.exe          Hitachi SH-C++ pre-                
                                               processor.                         
\Utl\Dev\Hitachi          shcprm.exe           Hitachi SH-C++ command-            
                                               line parameter analysis.           
\Utl\Dev\Hitachi          shctil.exe           Hitachi SH-C++ code                
                                               generation T phase.                
\Utl\Gfx                  Conv                 Graphics conversion and            
                                               processing utilities.              
\Utl\Gfx                  Samples              Sample 3-D models.                 
\Utl\Gfx                  View                 Simple Win32 texture               
                                               viewer.                            
\Utl\Gfx\Conv             Pc                   PC-based art processing tools.     
\Utl\Gfx\Conv             Sgi                  Silicon Graphics-based art         
                                               processing tools.                  
\Utl\Gfx\Conv\Pc          3DSMaxR2             Plug-in for 3D Studio Max          
                                               R2.  Converts models from          
                                               R2 format to Ninja format.         
\Utl\Gfx\Conv\Pc          Gigen                Ninja global index generator.      
                                               Ninja textures are uniquely        
                                               identified by an integer.          
                                               This utility renumbers all         
                                               the textures in a directory.       
\Utl\Gfx\Conv\Pc          Lightwav             Plug-in for Lightwave.             
                                               This plug-in exports               
                                               Lightwave format to                
                                               Ninja format.                      
\Utl\Gfx\Conv\Pc          Softimag             Softimage model                    
                                               to Ninja converter.                
\Utl\Gfx\Conv\Pc          Texture              Texture conversion and             
                                               compression utilities              
                                               that run on the command            
                                               line.                              
\Utl\Gfx\Conv\Sgi         ninjasgi.tar         Alias to Ninja file converter for  
                                               Silicon Graphics workstations.     
                                               This file is a Un*x tar archive.   
\Utl\Gfx\Conv\Sgi         siexpm2.tar          Softimage for SGI to               
                                               Ninja exporter.  Optimized         
                                               for the mips2000 series            
                                               of processors.                     
\Utl\Gfx\Conv\Sgi         siexpm4.tar          Softimage for SGI to Ninja         
                                               format converter.  Optimized       
                                               for the mips4000 series of         
                                               processors.                        
\Utl\Gfx\Samples          3DSMax               Sample models created              
                                               using 3D Studio Max                
                                               version R2.                        
\Utl\Gfx\Samples          Alias                Sample models created              
                                               using Alias.                       
\Utl\Gfx\Samples          Lightwav             Sample models created              
                                               with Lightwave.                    
\Utl\Gfx\Samples          Softimag             Sample models created              
                                               using Softimage.                   
\Utl\Gfx\Samples\3DSMax   Arm                  A scooping and lifting             
                                               mechanical arm.                    
                                               Animation included.                
\Utl\Gfx\Samples\3DSMax   Ball                 Texture-mapping logo               
                                               onto a lit sphere.                 
\Utl\Gfx\Samples\3DSMax   Bkanga               Dinosaur constructed               
                                               from abstract geometric            
                                               primitives.  A simple              
                                               animation is included.             
\Utl\Gfx\Samples\3DSMax   Bowl                 Ten pins and a bowling             
                                               ball on a wooden lane.             
                                               The animation shows                
                                               knocking over nine                 
                                               pins.                              
\Utl\Gfx\Samples\3DSMax   Face                 3D Studio Max standard             
                                               face animation.                    
\Utl\Gfx\Samples\3DSMax   Heli                 Model and animation                
                                               of a helicopter in                 
                                               a sky sphere.  Rotors              
                                               rotate.                            
\Utl\Gfx\Samples\3DSMax   Ikb                  The classic 3D Studio Max          
                                               bird, modelled with inverse        
                                               kinematic animation to             
                                               make its nose follow a             
                                               rubber duck.                       
\Utl\Gfx\Samples\3DSMax   Mirrorbx             A cube with a tiled                
                                               texture map.                       
\Utl\Gfx\Samples\3DSMax   Shpbend              A bending cylinder.                
\Utl\Gfx\Samples\3DSMax   Teapot               Everyone's favorite Utah           
                                               teapots.  The animation            
                                               stretches and scales               
                                               three independent                  
                                               teapots.                           
\Utl\Gfx\Samples\3DSMax   Texbox               Another cube, this time            
                                               with five independent              
                                               textures, one for each             
                                               face.                              
\Utl\Gfx\Samples\3DSMax   Torus                Torus with an environmental        
                                               building map.                      
\Utl\Gfx\Samples\Alias    Loop                 A strip with two twists.           
                                               Animation shows a ball             
                                               travelling around the              
                                               strip.                             
\Utl\Gfx\Samples\Alias    Sysmark              The Sega of Japan                  
                                               System R&D logo,                   
                                               modelled in Alias.                 
\Utl\Gfx\Samples\Alias    Ufoman               The Alias UFO guy,                 
                                               bouncing up and down               
                                               in his UFO.                        
\Utl\Gfx\Samples\Alias    Woman                An animation and model             
                                               of a walking woman.                
\Utl\Gfx\Samples\Lightwav Fish                 A three-segmented fish             
                                               with swimming animation.           
\Utl\Gfx\Samples\Lightwav Jump                 Model and animation                
                                               of a jumping robot.                
\Utl\Gfx\Samples\Lightwav Koke                 Model and running                  
                                               animation of koke.                 
                                               See also the Ninja                 
                                               koke sample program.               
\Utl\Gfx\Samples\Lightwav Okori                A stylized animation               
                                               scene, mirrored across             
                                               a plane.                           
\Utl\Gfx\Samples\Softimag F40Strip             A race car model,                  
                                               generated with Ninja's             
                                               strip optimizer.                   
\Utl\Gfx\Samples\Softimag Fishman              The model from the                 
                                               looping Ninja fishman              
                                               demo.                              
\Utl\Gfx\Samples\Softimag FshStrip             The same model as                  
                                               fishman, but generated             
                                               with the Ninja strip               
                                               optimizer.                         
\Utl\Gfx\Samples\Softimag Nasumap              A sample track model.              
\Utl\Gfx\Samples\Softimag Por                  Another race car model.            
\Utl\Gfx\Samples\Softimag Rocktman             Our hero Rocketman                 
                                               pushing a bicycle as               
                                               fast as it will go.                
\Utl\Gfx\Samples\Softimag soccerStrip          Optimized soccer model.            
\Utl\Gfx\View             PvrViewer            PvrViewer, a Win32                 
                                               .pvr texture file displayer.       
\Utl\Gfx\View\PvrViewer   nj_pvr.dll           Required DLL for                   
                                               pvrviewer.exe.                     
\Utl\Gfx\View\PvrViewer   pvrviewer.exe        A quick and dirty .pvr             
                                               viewer application.                
                                               To use PvrViewer, drag             
                                               and drop the .pvr file             
                                               you want to view into any          
                                               of the subwindows in               
                                               the PvrViewer application.         
