==============================================================
         Intel(R) Graphics Performance Toolkit (GPT)
                    Version 3.5
                  March 1, 2000
==============================================================
 
------------
INTRODUCTION
------------
This readme file contains the following:

 - System Requirements
 - Installation Instructions
 - Performance
 - Profiling Multiple Applications
 - Disk Usage
 - Overwriting of ddraw.dll, opengl32.dll, and glu32.dll
 - Changing the Data Logging Directory
 - Known Issues
 - Tips and Tricks
 - Systems on which GPT has been tested.

See also the Software License Agreement, license.txt.

For all other questions either email us at: 
  ipeak@intel.com
or go to the Intel website at:
  http://support.intel.com/support/performancetools/vtune/gpt/

-------------------
System Requirements
-------------------
The Graphics Performance Toolkit (GPT) requires the following 
hardware and software.  The software must already be present 
on the system before installing GPT:
  -- Windows* 98, Windows NT*, or Windows 2000
  -- DirectX* 7.0 or higher and/or OpenGL* version 1.1 
  -- Pentium(R) microprocessor 166 MHz or better
  -- 32 MB RAM or more
 Because GPT reduces the performance of the application being 
 profiled, we recommend that your system be as far above the 
 minimum requirements as possible.
------------
Installation
------------
GPT can be installed on Windows 98, Windows NT, or a Windows 
2000 system.  On both the Windows 98 and the Windows 2000 
systems, DirectX 7.0 or higher and OpenGL version 1.1 must 
be installed.

If you have a previous version of GPT, you should un-install 
it before you install this latest version.  Both older and 
newer versions of GPT cannot be installed at the same time. 
(GPTv3.5 will request that the other version(s) be un-installed
before it will install)
 
To install GPT, perform the following steps:
1. From the Windows desktop, close all open applications.
2. Insert the CD-ROM into the drive.
3. An Autoplay program prompts you to install GPT.  If this 
   does not happen, run the Setup.exe program which is located 
   in the setup folder.
4. A Setup program prepares the InstallShield* Wizard for the 
   GPT program. Read all instructions and when ready, click 
   Next.
5. Use the Page Down key to read the License Agreement.  Upon 
   acceptance, click Yes.  If you choose to reject the License 
   agreement, GPT will not be installed.
6. The default installation directory is under the folder 
   C:\Program Files\Intel\GPT.  
   Click Next to accept the default folder.  To select a 
   different folder, click the Browse button.
7. Install the GPT Icon under the Start menu by using one of 
   these methods:
   --  Click the Next button to install the icon in the default 
       folder. 
   --  To place the icon in a different program folder, select 
       a folder from Existing Folders and click the Next Button.
8. When installation is complete, click the Finish button.  You 
   may be prompted to restart your computer.  If you see this 
   prompt, you must restart before running GPT for the first 
   time.
9. When installation is complete you can run GPT from the Start 
   menu.

If you encounter any difficulties running GPT, see other 
entries in this README.TXT file.  For instructions on using 
GPT, see the Help file.

-----------
Performance
-----------
Profiling an application with GPT will degrade the performance 
of the application being profiled.  The amount will vary, 
depending on the type of analysis chosen.  The least impact 
occurs with the Frame Rate Tool setting and the greatest 
impact with an Advanced Analysis Tool with full data logging. 

--------------------------------
Profiling Multiple Applications
--------------------------------
It is strongly recommended that only one instance of GPT be 
run at one time. Additionally, only one 3-D graphics program 
should be run during a GPT analysis session.  For this reason, 
GPT should not be used to analyze multi-threaded applications 
or multiple-windowed applications.

----------
Disk Usage
----------
Profiling applications can quickly generate large data files. 
These files can be in excess of several hundred megabytes, 
depending on the type of analysis performed, the duration of 
the test run, and the application being profiled.  It is not 
possible to give accurate data generation rates because of the 
number of variables involved and the dependence on the actual 
application being profiled. 

-----------------------------------------------------
Overwriting of ddraw.dll, opengl32.dll, and glu32.dll
-----------------------------------------------------
Installing a game or upgrading DirectX or OpenGL might 
overwrite their respective dll stubs that GPT installs. If 
this happens, GPT will no longer be able to profile DirectX or 
OpenGL applications, and will report that GPT needs to be 
re-installed.  Re-installation of GPT at this juncture will 
solve the problem.

-----------------------------------
Changing the Data Logging Directory
-----------------------------------
GPT can log data to a directory or drive other than the one 
it uses as the default.  To change the logging directory, 
select the New Database option under the File menu, then 
select the new directory (and/or drive) in which the gpt.db 
file will be stored.
	
------------
Known Issues
------------

1.  It is very important that the latest video drivers be used 
    with GPT, as driver changes and 'fixes' are done on a 
    regular basis.  GPT relies on the video drivers being as 
    up-to-date as possible, as it uses cutting edge technology.
	
2.  Running multiple DirectX applications or OpenGL applications 
    while profiling with GPT will cause at least one of the 
    applications to not launch or not work correctly, and the 
    analysis may not be correct.
	
3.  GPT does not work with multi-threaded applications.  GPT 
    will not correctly account for which API calls occurred 
    within each thread.  This will lead to errors in the video 
    display and/or the statistics provided.

4.  For GPT to measure frames/sec (FPS) correctly, the correct 
    "Frame Delimiter" must be specified for the application 
    being tested.  If the correct frame delimiter for an 
    application is not known, usually it can be determined by 
    experimentation. For example, look at a Performance Tool 
    log to see which API functions are being called.

5.  GPT will degrade the performance of the application (the 
    frame rate), depending on the Analysis options you select.
    Usually, the impact to frame rate, from lowest to highest 
    impact, is:
        Frame Rate Tool(iFPS only)
        Performance Tool 
        Visual Feedback Tool
        Advanced Analysis Tool
	
6.  To analyze an application with a shell that launches a 
    second process to carry out the graphics or rendering 
    portion, select the checkbox "Ask for App Exit".  GPT will
    then prompt for notification that the application has 
    stopped. This will prevent a premature halt of GPT logging, 
    by requiring the user to give notification that the 
    application has stopped.

7.  If an application has a very high frame rate, or if a 
    large number of frames of data have been captured, the 
    respective data charts, data analysis windows, and API 
    Calls log will take a long time to load and open. If the 
    size of the data captured reaches the size of available 
    hard-disk space, GPT may unexpectedly quit.  This can be 
    avoided by maintaining a large free space buffer on your 
    disk, and by running GPT analyses in short (<50 frame) 
    analysis sets if they will use a lot of space.

8.  When using extensions to submit geometry or textures in an 
    OpenGL application, GPT only captures geometry and texture
    statistics submitted through normal calls and through the
    following extensions:
      GL_EXT_vertex_array
      GL_EXT_compiled_vertex_array
      GL_EXT_texture_object
      GL_ARB_multitexture

9.  When Windows is set for Large Fonts, some charts will not 
    display all available data.  The solution is to set Windows 
    to the normal setting (Small Fonts).

10. GPT will not open .gpt or .db files that were created with 
    earlier versions of GPT.  To save these earlier files, 
    rename them or place them in a directory that GPT is not 
    using. When you first run GPT, it will detect any 
    preexisting files and prompt you whether to delete them.  
    If you choose not to delete them, GPT will exit.  You can 
    then rename the files or the data directory before 
    restarting GPT.
	
11. After un-installing GPT, a warning dialog may appear prior
    to restart, saying that an incorrect version of ddraw.dll 
    is installed. This will be corrected when you restart the 
    system.
	
12. GPT cannot be used until all other applications using 
    DirectX are closed.  This also includes applications like 
    Internet Explorer 5.0* (IE5), which can load DirectX to 
    draw a 3D object.  In such cases, the application (IE5) 
    must be closed before running GPT.  If no other 
    applications appear to be running, you may have to restart
    the computer or run the Killhelp utility supplied in the 
    DirectX7 SDK.
	
13. In the Visual Feedback Tool, the following code usage 
    models do not work:
    DX tests:	Multiple Viewports (only certain limited cases)
                Mouse Click location control may not work
                2D Blits will not be scaled correctly in the 
                Quad view.
    GL tests:   Extensions
                Using a Feedback Buffer
                Selection Buffers
                Multiple Viewports (only certain limited cases)
                Mouse Click location control may not work
					
    In both cases, if the application overrides the use of the
    <Scroll Lock> and <Num Lock> keys, the toggling of Visual
    Feedback views may be impaired or may not function at all.
    The solution is to select other hot-keys for the Visual 
    Feedback Tool.

14. Currently, texel statistics in the OpenGL portion of GPT 
    are correct only with glSwapBuffers selected as the frame 
    delimiter. Additionally, texel statistics for the DirectX 
    portion of GPT are collected only for applications that 
    use DirectX 7 or later calls.
		
15. The Visual Feedback Tool for the DirectX portion of GPT 
    will not show any results if you attempt to profile 
    applications that use DirectX 6 or older calls.  All other 
    analysis modes will profile the application correctly 
    (except texel calculations described above).

16. The DirectX portion of GPT does not currently support 
    Retained Mode DirectX calls.  If you profile a Retained 
    Mode, DirectX application, the Retained Mode calls will 
    not be logged.

17. Visual Feedback Analysis on DirectX applications that 
    render a view to an offscreen surface, then use that 
    surface as a texture (using multiple BeginScene/EndScene 
    pairs), will display inaccurate results due to the method 
    used to generate the Visual Feedback analysis.
	
18. The OpenGL portion of GPT works for only those applications 
    that use the OpenGL32 dll, OpenGL v1.1. GPT will not be 
    able to profile applications that use other versions of 
    OpenGL.
	
19. In the OpenGL portion of GPT, if the check box 'Count 
    Rendered Triangles' is selected during Advanced Analysis 
    mode, and the incorrect frame delimiter is chosen, the 
    application execution screen may remain blank. The solution
    is to choose the correct frame delimiter.
 
20. The OpenGL portion of GPT has experienced difficulties in 
    Visual Feedback mode and in Advanced Analysis mode with 
    Count Rendered Triangles checked, with video cards that use 
    the Voodoo Banshee* or Voodoo 3 chip sets.  Some 
    applications that use Quads will slow down to a very low 
    frame rate, seeming to stop functioning.  Changing the 
    geometry to triangles fixes the problem.  Other applications 
    may lose textures.  Please make sure you are using the 
    latest revision of the driver available from the video 
    card vendor, as this may fix the problem.	
	
21. It is reported that some ATI drivers may be incompatible 
    with the OpenGL portion of GPT.  This is especially apparent
    with Windows 2000.  If OpenGL applications fail, or  
    fail to draw, check for driver updates at www.ati.com.

22. Profiling some applications with the Visual Feedback tool 
    will result in inconsistent screen refreshes or the Visual
    Feedback tool labels disappearing.

23. In certain applications, the instantaneous frame rate 
    graph will not be visible during execution with the Frame 
    Rate tool.

24. Some applications that use display lists (OpenGL), may 
    experience objects not being drawn in the Visual Feedback 
    tool or in Advanced Analysis with Count Rendered Triangles 
    checked.

25. Some strange visual effects may occur in the OpenGL portion
    of the Visual Feedback tool.  If this occurs, check the
    'gl Extensions off' checkbox, which may correct the problem.

26. GPT does not profile DirectX applications under Windows NT.

27. GPT will fail with the computer date set to the year 2099.

------------------------------
Tips and Tricks when Using GPT
------------------------------
GPT has been used as a profiling tool for the past year, and 
during that time users have discovered Tips and Tricks that 
help in their profiling, or that make GPT's data easier to 
read.  Here are some of their tips:

1.  If attempting to profile an application in Visual Studio*, 
    while it is being profiled by GPT, take the following steps:
	a) Launch GPT & select a non-3D application as the 
           profiled app. Our favorite is Notepad.exe.
	b) Launch the non-3D application (Notepad.exe) through 
           GPT, configuring the Application Test that matches 
           the test you want to perform on your 3D app.
	c) Debug the 3D application using Visual Studio.  Now 
           the application will run as though GPT launched it, 
           but you should be able to perform all your favorite 
           debugging tasks.
	d) Quit the 3D application.
	e) Quit the non-3D application (i.e. Notepad.exe).

    Note that on Windows NT and Windows 2000, Notepad will 
    need to be copied into the directory that the 3-D 
    application is located in.

2.  Rescaling a graph is easily done by right clicking on the 
    graph, selecting 'Axis', then 'Axis...', then either X or Y 
    axis.  Setting the Y-Axis to manual scaling is usually the 
    most often changed parameter - as this can be used to 
    'cut-off' spikes and other data discontinuities.

3.  Editing spreadsheet data within GPT.  
        a) Display the desired spreadsheet through GPT.  
        b) Double RIGHT CLICK in the spreadsheet window.  
        c) Now the Formula One* Workbook Designer will launch, 
           which allows editing, copying, and many other 
           manipulations to be done.
        d) Save the spreadsheet when finished.  You can save it 
           only for external use in a spreadsheet program, not 
           for re-use in GPT.

------------------------------
Systems GPT Has Been Tested On
------------------------------
GPT has been tested on systems using a Pentium(R) II processor,
Pentium III processor, and Celeron(TM) processor, in 
combination with the following graphics adapters and graphics 
chipsets: TNT*, TNT2, Rage 128, GeForce, Stealth III s540*, 
and Voodoo 3000.  All test systems had a minimum of 32MB of 
RAM and 100MB of free hard-disk space.

All systems were tested using the latest video drivers 
available for the respective systems.

==============================================================
Copyright(c) 2000 Intel Corporation.  All rights reserved.

Legal Notices:
Pentium is a registered trademark of Intel Corporation.
Celeron is a trademark of Intel Corporation.
* Third-party brands and names are the property of their 
   respective owners.
