  OpenPTC 1.0 C++ API X11 CLASSES Version 1.0.0 README
  Christian Nentwich (c.nentwich@cs.ucl.ac.uk)
  31/03/1999

  The X11 classes are Copyright (c) 1998/99 Christian Nentwich (c.nen-
  twich@cs.ucl.ac.uk) The OpenPTC 1.0 C++ API is (c) 1998/99 Glenn
  Fiedler (ptc@gaffer.org).  This package and all included source code
  is licensed under the GNU LGPL Please refer to the included file COPY-
  ING for the exact terms (Please read the CHANGES file first if you're
  upgrading!)
  ______________________________________________________________________

  Table of Contents


  1. OpenPTC Introduction

  2. Obtaining the newest version and documentation

  3. Tested platforms

  4. How to link your own program to PTC 2.0.* X

  5. Thankyous

  6. How to submit bug reports



  ______________________________________________________________________

  1.  OpenPTC Introduction

  OpenPTC is a standard for high-speed low-level graphics access. It is
  object-oriented and designed to be very easy to make a start with.
  OpenPTC has not been designed for any 3d acceleration, it provides a
  way of accessing raw pixel data conveniently accross platforms.


  In addition, OpenPTC will abstract the issue of pixel formats. You get
  to choose which format to render in, OpenPTC will convert it for you,
  (almost) no matter which pairs of formats you might encounter. Thus
  code written for (say) 32 bpp will work on any target screen depth -
  and indeed on any combination of the masks for red, green and blue.
  The same is true for code written for indexed colour modes, it will be
  converted to direct colour.


  2.  Obtaining the newest version and documentation

  You can get OpenPTC from:


  o  http://www.gaffer.org/ptc (All platforms)

  o  http://www.cs.ucl.ac.uk/students/c.nentwich/ptc (X11)


  You will also find the documentation you require at www.gaffer.org (an
  introduction to PTC, etc.). If you just want the newest PTC X release,
  go to the second homepage, as that's the one that guarantees an up to
  date release.




  3.  Tested platforms

  OpenPTC X11 has been compiled and run on the following platforms:


  o  RedHat Linux 5.1, x86 (egcs 1.0.2 -O6 -mpentium)

  o  RedHat Linux 5.1, x86 (pgcc 1.1 -O6 -mpentium)

  o  FreeBSD 2.2.7, x86 (gcc 2.7.2.1 -O2, gmake), some examples don't
     compile

  o  NOT YET - IRIX 6.3, SGI O2 (gcc 2.7.2 -O2)

  o  NOT YET - SunOS 5.dunno :), Sparcstation 4 (gcc 2.7.2 -O2)



  4.  How to link your own program to PTC 2.0.* X

  The following instructions assume you installed in '/usr/local/',
  which is the default and furthermore that /usr/local/bin is in your
  path.


  For compiling, you can execute 'ptc-config --cflags' to get all the
  flags you need to build a source file that includes <ptc/ptc.h> (which
  is the only thing you need to include by the way).


  For linking, execute 'ptc-config --libs' to link in PTC, Hermes and
  all the required X libraries.


  Have a look into the examples/ and docs/ directory for more
  information, including the API.


  Example command lines:

  o  Compiling:

       "g++ -c cooleffect.cc -o cooleffect.o `ptc-config --cflags`"


  o  Linking:

       "g++ cooleffect.o -o cooleffect `ptc-config --libs`"




  5.  Thankyous

  Handshakes and a pat on the shoulder to the following people for being
  very helpful in identifying problems with PTC X11.


  o  Hilarion (rhogan@mnsi.net)

  o  Nado (nado@ottawa.com)

  o  Ghyll (ghyll@iname.com)



  6.  How to submit bug reports

  If don't mind, send an e-mail to brn@eleet.mcb.at if something goes
  wrong and include the following files (check if the bug is know first,
  read the BUGS file):


  o  config.log

  o  config.status

  o  XF86Config (or your Metro-X config, or whatever)

  In addition, please run the xdpyinfo program and send me the stuff it
  produces (this is quite important):


       xdpyinfo > visual.x11



  It would also be quite useful if you could tell me your compiler
  version and which version of X you are using if it is < R6. I'd be
  forever thankful ;)


  If you are very keen on helping me, then recompile PTC with the debug
  flag -g on, run the faulty program in gdb, like 'gdb faulty'. Type
  'run', make sure it crashes. And then type 'bt' to show a backtrace.
  Stick that in an e-mail and I'll be able to see where to bug occured.

  Thanks, brn
