/**************************************************************************
 * MACH64 ACCELERATOR PROGRAMMER'S GUIDE SAMPLE CODE DISKETTE             *
 *                                                                        *
 * to be used in conjunction with the mach64 Software Developer's Kit     *
 *                                                                        *
 * Author: Developer Relations  1998 03 07                                *
 *                                                                        *
 * Copyright (c) 1994-1998 ATI Technologies Inc. All rights reserved      *
 **************************************************************************/

READ THIS FILE COMPLETELY BEFORE ATTEMPTING TO USE THIS PRODUCT !

ATI Technologies Inc.
33 Commerce Valley Drive East
Thornhill, Ontario
Canada L3T 7N6

Developer Relations Hotline ............ (905) 882-2600 ext. 6000
Engineering/Developer Relations FAX .... (905) 882-9339
Developer Relations E-mail ............. devrel@atitech.ca

Please direct all inquiries about this SDK to Developer Relations at
one of the above two numbers or via the E-mail address.

Head Office, Sales and Marketing ....... (905) 882-2600
Corporate FAX .......................... (905) 882-2620

World Wide Web ......................... http://www.atitech.ca

***************************************************************************

Contents

1.0     Installing the Sample Code
2.0     Compiling
3.0     Executing
4.0     Sample Code Listings
 4.1    SDK Chapter 3 Code
 4.2    SDK Chapter 4 Code
 4.3    SDK Chapter 5 Code
 4.4    SDK Chapter 6 Code
 4.5    SDK Chapter 7 Code
 4.6    SDK Chapter 8 Code
5.0     Reporting Problems

***************************************************************************

1.0     Installing the Sample Code

You will need to use PKUNZIP, version 2.0 or higher, to unzip the SDK
archive.  You should use the "-d" option (create subdirectories) as in:

    PKUNZIP -d M64VTSDK.ZIP

The subdirectory SAMPLE will be created containing the sample code.  Each
Chapter has its own subdirectory.  Within each Chapter directory, each code
example also has its own subdirectory, as well as an object directory.

***************************************************************************

2.0     Compiling

The code contained on this diskette was created using Watcom C 11.0 in
Dos Protected Mode using the DOS/4GW extender.  The DOS4GW.EXE program
is needed to run all executables on this diskette.  This program must be
located on your path or within the directory of the executable that you
want to run.

To compile any of the code examples, change to the example's directory
and type WMAKE or a similar makefile utility.  Please note that for
chapter 6 and 7, you must make the utility library located in directory
/SAMPLE/CHAP6/UTIL.

Located within the /SAMPLE directory is a COMPILE.BAT file.  This batch
file will compile and link all of the sample programs.  It assumes the
make utility is WMAKE from WATCOM C.

All programs and modules were written in Watcom C.  The .exe files
included were compiled by the Watcom C 11.0 compiler with all debugging
information stripped out.

***************************************************************************

3.0     Executing

To execute any of the code examples, change to the example's directory and
type the executable filename.  To run all of the examples in sequence,
change to the SAMPLE directory and type RUN.  Arguments of x resoulution
and pixel depth can be passed to the RUN.BAT file, as with all the
individual executables.  The order that arguments are passed is not
important.  For example:

     RUN 1024 16
or
     RUN 16 1024

will both run all executable programs with a spatial resolution of 1024
by 768 and a colour depth of 16bpp.  Valid arguments include 8, 15, 16,
32, and 64 for pixel depth, as well as, 640, 800, 1024, 1280, and 1600
for spatial resolution.  The default is always 640x480 and 8bpp.  Some
executables are not available in various resolutions.  You will always
be notified if the requested resolution is unavailable.

Note that most of the sample code examples require keyboard input (i.e.
press a key) to step through the programs and to exit.

***************************************************************************

4.0     Code listings

Detailed descriptions of each program can be found in the README.TXT
files of their respective chapter subdirectories.  In addition, a short
explanation of each program is given upon execution.

 4.1    Chapter 3 Code
          bmode.exe    - graphics initalization and mode setting

 4.2    Chapter 4 Code
          linear.exe   - using the linear aperture

 4.3    Chapter 5 Code
          engine.exe   - engine initalization

 4.4    Chapter 6 Code
          rect.exe     - drawing simple rectangles
          line.exe     - drawing simple lines
          compare.exe  - colour compare logic
          mix.exe      - source and destination mixing logic
          sblit.exe    - simple bitblits
          gpblit.exe   - general pattern bitblits
          gprblit.exe  - general pattern bitblits with rotation
          slblit.exe   - strictly linear bitblits
          meblit.exe   - monochrome expansion bitblits
          gpline.exe   - general pattern line bitblits
          tblit.exe    - transparent bitblits
          fixpat.exe   - fixed pattern consumption
          scissor.exe  - scissoring and masking
          cursor.exe   - hardware cursor implementation

 4.5    Chapter 7 Code
          polygon.exe  - polygon drawing
          polygon2.exe - polygon drawing using draw engine
          pan.exe      - creating a virtual desktop
          sbufp.exe    - single buffered animation with polling sync
          dbuf.exe     - double buffered animation with clock sync
          sbufi.exe    - single buffered animation with CRTC VLINE sync

 4.6    Chapter 8 Code
          overlay.exe  - using the VT/GT overlay
          scaler.exe   - using the VT/GT scaler
          csc.exe      - using the Colour Space Converter
          keyer.exe    - using the Overlay Keyer
          fescaler.exe - blt using the front end scaler
          switch.exe   - blts and scaling using the front end scaler
*****************************************************************************
*                                                                           *
*                           W A R N I N G ! !                               *
*                                                                           *
* The following bus master examples may not operate properly if run under a *
* Windows 95/98 DOS box or command prompt.  We have experienced issues with *
* the DOS4GW extender and DPMI services that may lock your system.  It is   *
* highly recommeded that you boot your system with DOS to ensure proper     *
* operation.                                                                *
*                                                                           *
*****************************************************************************
          bmaster.exe  - system bus master operation 
          bmgui.exe    - execute GUI operation using the bus master
          
***************************************************************************

5.0     Reporting Problems

If you experience any difficulties, please contact Developer Relations at
(905) 882-2600 extension 6000, send a Fax to (905) 882-9339, or send E-mail
to devrel@atitech.ca.

***************************************************************************
