home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / pointers / pointer / readme < prev    next >
Text File  |  1991-01-11  |  2KB  |  66 lines
  1. ZZ POINTER
  2. by Timm Martin
  3.  
  4.  
  5. INTRODUCTION
  6.  
  7. This archive contains a few functions to allow you to use the ZZ sleepy
  8. pointer used in SID.  Included are 5 files:
  9.  
  10.    README ......... what you are reading now
  11.    zz_pointer.c ... all of the pointer functions
  12.    zz_pointer.h ... header file for programs using these functions
  13.    test.c ......... test program showing you how to use these functions
  14.    test ........... executable form of the test program
  15.  
  16.  
  17. LEGAL JUNK
  18.  
  19. All of this source is public domain.  You may use it in any program,
  20. commercial or non-commercial, without acknowledgement of or compensation to
  21. the author.
  22.  
  23. All of the source was written to conform to ANSI C standards and compiles
  24. cleanly using Manx C v5.0b (and compiler options -pas -wadpru).
  25.  
  26.  
  27. GETTING STARTED...QUICKLY!
  28.  
  29. --  Place the zz_pointer.h header file in the current directory and add the
  30.     following line to the beginning of your source file:
  31.  
  32.         #include "zz_pointer.h"
  33.  
  34. --  In your program startup function, call the zz_pointer_open() function,
  35.     checking its return value.  If FALSE, you should end the program.
  36.  
  37. --  In your program cleanup function, call the zz_pointer_close() function.
  38.  
  39. --  To display the ZZ pointer, call the ZZ_POINTER() macro defined in
  40.     zz_pointer.h, passing it a pointer to your window.
  41.  
  42. --  To clear the pointer (returning it to the system default), call the
  43.     CLEAR_POINTER() macro defined in zz_pointer.h, passing it a pointer to
  44.     your window.
  45.  
  46. --  Compile the zz_pointer.c source file.  Be sure to link this file with
  47.     your main program, for example (with the test.c program and Manx C):
  48.  
  49.         ln test zz_pointer -lc
  50.  
  51.  
  52. A FEW DETAILS
  53.  
  54. The zz_pointer_open() function copies the pointer data into CHIP RAM so you
  55. don't have to worry about setting any special linker flags.  The pointer data
  56. must reside in CHIP RAM for the graphics chip to correctly display it.  The
  57. zz_pointer_close() function then frees the allocated CHIP RAM.
  58.  
  59. The test program shows you just how easy it is to display the ZZ pointer.
  60. When you run the test program, click the left mouse button in the window.
  61. Each time you click the button, the pointer will cycle between the ZZ pointer
  62. and the default window pointer.
  63.  
  64.  
  65. /*--- END OF TEXT ---*/
  66.