Indy3D 3.0 / July 13th, 1998
------------------------------

INDEX
=====
- Instructions to run Indy3D
- Update history
- Driver HW issues
- Known Indy3D problems
- Batch file directions
- Instructions to load results.txt into Excel

==========================================================================
Instructions to run Indy3D
==========================================================================

Windows NT/95
	The setup program will create shortcuts on your desktop as well as 
	program menu under Indy3D. Click on the appropriate shortcut to run
	the Indy3D benchmarks.

Unix Platforms (SGI, HP, and SUN)
	Upon extracting the tgz file in the Indy3D directory you will find
	4 script files. Those are:
	go_off   -- to run the official indy3d benchmark in GUI mode
	go_8MB   -- to run Indy3D with the 8MB texture database in GUI mode
	go_16MB  -- to run Indy3D with the 16MB texture database in GUI mode
	go_batch -- to run the official indy3d benchmarks in batch mode


==========================================================================
Update History
==========================================================================
Ver 3.0 Release
	* Added MCAD150 test with 150,000 polygon engine database
	* Changed MCAD engine models to be single-sided polygons instead of both-sided
	* Changed MCAD motion path to decrease the average size of polygons
	* Removed LODs from MCAD engine database
	* Changed Animation test to use immediate mode instead of display list mode
	* Fixed convergence method for polygons larger than 25 pixels
	* SGI platforms now default to Anti-Aliasing mode
	* Disabled user test
	* Released new versions for SGI, HP, Sun and Digital Alpha

Ver 3.0 (Beta 1)
	* Added demo modes for user tests
	* Added side-by-side reference image viewing
	* Added user test in which any model can be loaded

Ver 2.2
	* Release versions for SGI and AlphaNT
	* Common Image Quality issues added to documentation
	* Changed convergence algorithm for fixed rate test to work more reliably
	* Fixed bug in batch mode in which texture modes weren't set correctly
	* Added a user comment to HTML -- user in GUI mode is prompted for it.

Ver 2.1
	* Released beta versions for SGI and AlphaNT
	* Fixed bug in batch mode in which directed light wasn't on by default for
	  Indy3D settings
	* Requesting a non-stereo PFD explicitly to fix ELSA'a problems

Ver 2.0
	* Final methodology released
	* Added documentation
	* Results generated as comma delimited ASCII file (result.txt)
		- User tests are grouped together
		- Primitive tests and Image Quality test are grouped
		- Easy import to Excel for detailed analysis
	* Text added to status bar while running test to display state 
		- Converging/Measuring or Stabilizing/Measuring
	* Ambient light is not counted in total number of lights
	* Added self extracting exe for install
	* Changed MCAD methodology:
		- One complete run in WireframeAA and one with complete
		  run as smooth-shaded. 
		- Results computed: 1/3(wireframe) + 2/3(Shaded)
	* Changed Animation methodolgy:
		- viewpoint orbiting changed to spiral in close to the
		  face before receding
	* Added HTML output for Image Quality test

Ver 1.5
	* Changed MCAD test
		- Viewpoint moves in close to engine part before swinging
		  away and viewing engine from a distance.
		- The viewpoint zoom in for 10 frames
		- Stays at that point for 5 frame
	* Added install program for Indy3D

Ver 1.4
	* The view results dialog tells the test resolution
	* The scrolled list inside it resize when the form is resized
	* Models fixed and high res. textures for sailing added.
	* Fields for HD page faults and CPU usage, Scene and line AA added.
	* Modified animation benchmark with viewpoint panning close to the character.
	* HTML output fixed to run on Netscape too.
	* Fixed bug in sailing in which models was gettin unprebuilt inadvertently.

Ver 1.3
	* A mipmap test has been added to the image quality test. 
	* Security feature added. Checks for texture and models. Verifies size of
	models.
	* A borderless splash screen centered on screen is shown when a user
	benchmark loads.
	* New prebuild logic -- faster loading time and more interactivity while
	changing parameters. Though it take some time to prebuild (especially in
	animation) to prebuild before running test.
	* Resized and incorporated new splash screens
	* Fixed crash on Win95 
	* Fixed crash on Compaq (Accelgraphics card) 
	* In viewing reference images the message box now comes on the top left
	corner of the screen.

Ver 1.2
	* Checks whether board has line and scene anti-aliasing.
	* Tells the %processor time used by Indy3D while running the user-benchmarks.
	* Tells the hard page faults/sec while running the user-benchmarks.
	* Saves test images as JPEG's (viewable in HTML).
	* Run test added to image quality.

Ver 1.1
	* The name has been changed to Indy3D from u3DBench
	* The user interface has been revamped.
		-- Lot of controls now use check buttons rather than radios thus better
		utilization of space.
		-- A new row has been added which has 2 controls
		Reset View ( take you to default view for user-tests
		Hide Gauges ( Hides the dials)
	* The batch mode has the ability to set the gauges state 
	* HTML output directories are named Indy3D(Data)_(Time)
	* The VRML file for the image quality test has been changed to more
	effectively show Z-buffer problems, banding, and texturing problems.
	* A batch mode has been added to Indy3D. The following section describes 
	how to use the batch mode.

==========================================================================
Driver/HW issues:
==========================================================================
3D Labs:
-------
#1 MCAD test: engine is dark instead of lit, adding spotlights causes it to
light.
Indy3D:		1.3
Hardware:	All 3D Labs boards
Driver: 	2.9.3, 4.0.0
Date:		11/20/97
Status:		Fixed with 2.11.266 driver

#2 Quality Image test: Non display of polygon with vertex colors
Indy3D:		1.3
Hardware:	All 3D Labs boards
Driver: 	2.9.3, 4.0.0
Date:		11/20/97
Status:		Fixed with 2.11.266 driver

#3 General: version 2.11.266 drivers don't work with Omnicomp and
Accelagraphics MX boards on Compaq 5100 and 6000 systems. System blue-screens.
Indy3D:		1.3
Hardware:	Omnicomp/Accelagraphics MX boards
Driver: 	2.11.266
Date:		11/20/97
Status:		3D Labs informed

E&S 3D Pro:
----------
#1 General: Memory leaks causing excessive amounts of memory to be used
(many 10s of Mbs).
Indy3D:		1.3
Hardware:	All 3D Pro
Driver: 	2.
Date:		11/20/97
Status:		E&S informed, version 1,2,15,2,4.0.0 recommended for now

#2 General: Indy3D fails on initial execution.
Indy3D:		1.2
Hardware:	All 3D Pro
Driver: 	1.
Date:		11/20/97
Status:		Fixed in Indy 1.3 (better detection of glGetTexture)

#3 General: after repeated runnings of Indy3D, the textures become
scrambled and the wrong texture is used.
Indy3D:		1.3
Hardware:	All 3D Pro
Driver: 	1.XXX
Date:		11/20/97
Status:		E&S informed

#4 General: textures in all tests appear banded even though
24-bit color and 32-bit texels enabled in driver.
Indy3D:		2.0
Hardware:	All 3D Pro
Driver: 	2.XXX
Date:		12/11/97
Status:		E&S informed

#5 Fill Rate: Incorrect results computed for textured fill
Indy3D:		All
Hardware:	All 3D Pro
Driver: 	upto 2b1019 
Date:		12/11/97
Status:		Fixed in drivers released after 10/19/97

Dynamic Pictures:
----------------
#1 Image Quality: Some of the squares in the checkerboard pattern on the
floor disappear as you move into the scene.
Indy3D:		1.3
Hardware:	402
Driver: 	Latest
Date:		11/20/97
Status:		Dynamic Pictures informed

#2 MCAD test: engine is dark instead of lit, adding spotlights causes it to
light.
Indy3D:		1.3
Hardware:	402
Driver: 	latest
Date:		11/20/97
Status:		Dynamic Pictures informed

Matrox:
----------------
#1 General: hardware acceleration doesn't seem to work, performance is very
slow.
Indy3D:		all
Hardware:	Millenium/Mystique (not MilleniumII)
Driver: 	all
Date:		11/20/97
Status:	When WTK requests a 24 bit Z-buffer, the Matrox driver may supply
this by switching to software rendering mode instead of supplying a 16 bit
Z-buffer. To achieve hardware acceleration with these boards, use the
following environment variable (set this up in the System dialog under NT
or in the autoexec.bat in Win95)
	set WTKZBUFFERSIZE=16
This will tell WTK to request a 16 bit Z-buffer so that it will work with
the Millenium I/Mystique. As far as we know, this problem only impacts
Matrox drivers and not other vendors with 16-bit Z-buffer hardware.

#2 General: Splash screens don't show up, they appear white
Indy3D:		all
Hardware:	Millennium II, ATI's Xpert@work, Number 9 Revolution 3D
Driver: 	all
Date:		12/10/97
Status:	When Indy3D pops up a splash screen, it is displayed as a white
box. Indy3D uses a certain OpenGL call that looks like it isn't supported on
these boards. We are reading a 24-bit TARGA file and displaying it using 
glPixelZoom and a glDrawPixel. This works fine on a large number of OpenGL 
boards, so we are pretty confident about our code. Vendor informed of 
problem.

Hitachi:
----------------
#1 Image Quality: Quad polygon at the very top of the frame always stays
yellow or orange. It doesn't show levels of mipmap.
Indy3D:		all
Hardware:	Spherix
Driver: 	unknown
Date:		11/20/97
Status:	The Hitachi drivers may not support certain OpenGL texture
extensions that allow us to dynamically create the mipmap levels. We
believe this is the cause of the problem.

Intergraph:
----------------
#1 Simulation and Animation: Turning directed lights on causes a greenish
color on the boat. Turning off directed lights makes everything look OK.
Indy3D:		all
Hardware:	TDZ2000, Realizm II VX25 GT
Driver: 	04.03.01.02 and 04.03.01.12
Date:		12/22/97
Status:	Vendor has been notified. Problem fixed with driver 04.03.02.18 (12/24/97)

Digital:
----------------
#1 Simulation: Translucent sail "disappears" when the simulation test run begins,
but looks fine prior to starting the test. Also, fog effect doesn't seem correct.
Indy3D:		all
Hardware:	Powerstorm 4D60T with 32MB of texture memory
Driver: 	unknown
Date:		1/13/98
Status:	Vendor has been notified.

==========================================================================
Known problems/issues with Indy3D
==========================================================================
#1 General: Indy3D generates a "WTK-ERROR - Out Of Memory".
Indy3D:		all
Hardware:	all
Driver: 	NA
Date:		11/30/97
Status:	If there isn't sufficient virtual memory, or sometimes if the
graphics hardware driver doesn't properly page textures when texture memory
is exceeded, you may get this message. You can either make sure more system
RAM is available to Indy3D or add texture memory to your hardware or use
the 4Mb texture memory version of Indy3D.

#2 Fixed rate test convergence repeatability
Indy3D:		2.0
Hardware:	low-end machines and some high-end machines
Driver: 	NA
Date:		12/10/97
Status: The fixed rate may not converge on low-end machine. We are working on
changing the convergence logic to be more precise and repeatable.

#3 Increasing memory requirements
Indy3D:		2.0
Hardware:	all
Driver: 	NA
Date:		12/11/97
Status: Every time you hit the "Run Test" button in the Simulation measurement,
a memory leak causes another 600Kb to be allocated. We are looking into this.

#4 The Internet Exlporer v3.02 browser crashes on exit
Indy3D:		2.0
Hardware:	all
Driver: 	NA
Date:		12/10/97
Status: Playing an AVI file in IE v3.02 causes the browser to crash on exit.
This problem is not seen on Netscape or in IE V2.0 or V4.0

#5 Uninstall from the menu bar does not work properly
Indy3D:		2.0
Hardware:	all
Driver:		NA
Date:		12/11/97
Status:  	FIXED in Ver 2.1

#6 Screensavers may alter results
Indy3D:		2.2
Hardware:	all
Driver:		NA
Date:		1/22/98
Status:		If screensavers are launched or are in use during an Indy3D
		run the Indy3D results (performance data and images) may not 
		be valid.  Work around is to disable screensavers--particularly
		when using non-GUI mode.

#7 Mipmap modes in RE2
Indy3D:		2.2
Hardware:	SGI RE2
Driver:		NA
Date:		1/22/98
Status:		In the image quality test in the yellow polygon on the top,
		different color bands corresponding to mipmap levels don't show
		up.

#8 Rendering window capture mouse after simulation test
Indy3D:		all
Hardware:	all
Driver:		NA
Date:		7/13/98
Status:		In the simulation test, after running the test the rendering
		window captures the mouse input. You need to click once on the control
		panel for the capture to be released. Subsquently all mouse clicks work
		as expected.

#9 Large fonts make control panel items unreadable
Indy3D:		all
Hardware:	Windows 95, Windows NT (Intel and Alpha)
Driver:		NA
Date:		7/13/98
Status:		When large fonts are used the menu item on the control panel become
		too large and hence unreadable. The solution is to use small fonts.



==========================================================================
Batch File Description
==========================================================================
If you use the batch version of the program, you can perform hands-off 
testing in an automated fashion.

To run the batch mode simply double click on the batch file go_batch.bat or type 
Indy3D.exe  -b[batchfile name]

Example: Indy3D.exe -bBENCHBAT.TXT 

The output of this is an HTML file created in a directory with a Indy3D suffixed
by the date and time of the test.

*Note* to run the test in non-batch *do not* use any arguments.

An example BENCHBAT.TXT file with a canned set of typical
measurements has been provided.

The command in the batch file are self explanatory but here is a description
of the User interface items and their corresponding command and the 
arguments they take. 

Batch Command		Batch Argument					Description
-------------		--------------					-----------
Test		=	FillRate/FixedRate/PolygonRate/			Selects test
			Animation/MCAD40/MCAD150/Simulation/
			ImageQuality

PolygonSize	=	25/50/500					Selects polygon size
			(Used only in Fixed & Polygon Rate)

XResolution	=	0 - to system MAX X Resolution			Selects the X size in 
(Test X res)		e.g. 640					pixels

YResolution	=	0 - to system MAX Y Resolution			Selects the Y size in
(Test Y res)		e.g. 480					pixels

Fog		=	On/Off						Turns fog on or off

Translucency	=	On/Off						Turns translucency on or off

Shading		=	On/Off						Turns shading on or off

RenderMode	=	Polygon/Wireframe/WireframeAA			Selects rendering mode 
			(Note AA stands for AntiAliased			for polygons		

Texturing	=	On/off						Turns texturing on or off

TextureMode	=	Point/PointMM/Bilinear/				Selects texture filtering 
			BilinearMM/Trilinear				mode
			(Note MM stands for MipMap

Texture		=	Logo/Geometry/Brick				Maps one of these textures
			(Used in Fill/Fixed/Polygon/MCAD)

DirectedLight	=	On/Off						Turns directed light on or off

SpotLights	=	0 to 6						Turn on the number of spot lights specified

RotateLights	=	On/Off						Turns on or off the 
		
Gauges		= 	On/Off						Turn on or off the gauges												rotation of lights

Run		=	Test/Indy3D					Test runs with arguments
									specified while Indy3D runs
									test with default settings


Specifying Comments
===================

can be given in any line after specifying
# or ;
e.g. 
# comment here
; comment here

Note:
=====
*	If a test is run with Indy3D then test parameters needn't be specified.
	For e.g the following would suffice.
	Test	= Animation
	Run	= Indy3D
	However, if parameters are indeed specified, they would be ignored.

*	If an illegal argument or command is specfied, test execution stops with 
	a messagebox popping up to tell the illegal command/argument and the line number.
	Test execution would stop at this point and HTML output would be generated for
	the tests conducted up to that point.

==========================================================================
Instructions to load results.txt into Excel (Office 97)
==========================================================================

1.	Goto the File menu and click on Open to select the file to load. You may have to
	select the files of type text.
2. 	The file import wizard will come up. Choose Delimited file type (which should be 
	the default).
3.	Click on next to goto the next screen. Amongst the delimiters, "tab" should be 
	selected. If not, check the "tab" delimiter and uncheck others.
4.	Click next again, choose General as the column data format (again the default)
5. 	Click finish to view the results in Excel.
  

