home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / GSCROLL.LHA / gscroll / gscroll.doc < prev    next >
Encoding:
Text File  |  1995-10-03  |  6.1 KB  |  167 lines
  1. Short: Program to scroll Texts with (Color-)IFF-Fonts in a Window
  2. Type: dev/c
  3. Author: Reinhard Katzmann
  4. Uploader: Reinhard Katzmann
  5.  
  6. GScroll - A program which scrolls a text in a window
  7. ====================================================
  8.  
  9. (C) 1995 Reinhard Katzmann. All rights reserved.
  10.  
  11. Introduction
  12. ------------
  13.  
  14. I've written this program as I got a CD with many colour fonts and IFF Fonts
  15. on it and thought one some so calles "Intros" which are mostly written in
  16. Assembler and not very system friendly.
  17.  
  18. This program uses only system functions (for scrolling, blitting and remapping.)
  19. In the current form, remapping is only done under OS3.x and higher.
  20. The program should also work on OS2.x but I could not test this.
  21.  
  22. One example font is included and also an example usage with topaz/11. This
  23. only works, if you have installed the Font Datatype (can be found on aminet).
  24.  
  25. I cannot make clear statements on the speed of the program. On my A4000/040
  26. it is quite a smooth scrolling. At least it should not flicker somehow.
  27. Also the speed much depends on the size of the font. While topaz/11 is so fast
  28. that you cannot read it, with the font14 color font it is acceptable.
  29.  
  30. Disclaimer & Copyright
  31. ----------------------
  32.  
  33. GScroll is (C) 1995 Reinhard Katzmann. All rights reserved.
  34. GScroll is Public Domain in this Version (actually no version). I've included
  35. the source code which you are allowed to use in your own applications. The
  36. only condition is that you add to you documentation:
  37. This program is based/uses parts of GScroll (C) 1995 Reinhard Katzmann.
  38.  
  39. I keep the right to change all the above conditions of the program.
  40.  
  41. There is no guarantee in the usage of the program and/or sourcecode. Use
  42. it at your own risk!
  43.  
  44. Installation & Requirements
  45. ---------------------------
  46.  
  47. For full functionality, you should have OS3.x installed. If you want to use
  48. normal fonts you also need to have installed the Font Datatype which is
  49. (C) 1995 Michael Letowski.
  50.  
  51. Of course you need an Amiga. Probably it is good to have at least an 68020.
  52. (No panic, the program is not compiled with an 68020+ option ;-)
  53.  
  54. OS3.x is also needed for remapping of the colors of a font. I've planned
  55. to add this to OS2.x somewhen, too, if I know what to do with the program 
  56. itself. The program fully relies on datatypes picture class(es).
  57.  
  58. If you use OS2.x, you also must have iff.library installed which can be
  59. found on aminet (iff_library_23_2, util/libs).
  60.  
  61. Installation is done as follows:
  62.  
  63. Copy the main executable to a directory in your path. It only runs from CLI.
  64.  
  65. If you want to use the included Font14, copy the gscroll.font14 to firstly
  66. ENVARC:gscroll and secondly ENV:gscroll.
  67.  
  68. Copy this doc in you favourite Doc drawer, for example HELP:English.
  69.  
  70. Usage
  71. -----
  72.  
  73. GScroll. Copyright (C) 1995 by Reinhard Katzmann. All Rights Reserved.
  74. Usage: gscroll IFFFONT/A,TEXTFILE/A,W=WIDTH/K,H=HEIGHT/K,D=DEPTH/K,N=NUMCROW/K,R=ROWS/K,C=CHARS
  75.  
  76. IFFFONT/A: Required Argument. This must be an IFF picture (or an picture which
  77. can be produced by using datatypes picture class(es). So you can use f.e. the
  78. Font Datatype for using "normal" or color fonts.
  79.  
  80. TEXTFILE/A: Required Argument. This is the text which should be scrolled. It
  81. can have several lines (newline characters are replaced by blank characters).
  82.  
  83. W=WIDTH/K: Optional. The Width of the font (defaults to 32). This includes 
  84. spacing between the font characters (Important if you count the pixels with
  85. the help of a paint program).
  86.  
  87. H=Height/K Optional. Height of the font (defaults to 32).
  88.  
  89. D=Depth/K: The Depth of the Font (defaults to 3). A "normal" font has 1
  90. depth, i.e. two colors). Warning: The Font Datatype seems to have some
  91. problems with Color Fonts who have Depth>3 (at least with my CD).
  92.  
  93. N=NUMROW/K: Optional. Number of Font Charakters in a row. (defaults to 10).
  94.  
  95. R=ROWS/K: Optional. Number of Rows of Font Charakters (Defaults to 6).
  96.  
  97. C=CHARS: Array of Charakters which must have the same sequence as in the font.
  98. (look at gscroll.font14 and FONT14 itself for an example usage.)
  99.  
  100.  
  101. Bugs/Known Bugs
  102. ---------------
  103.  
  104. Resizing: If you resize the program, the current displayed scroll line diss-
  105. appears. I was too lazy to write a proper restore function for that.
  106.  
  107. OS2.x: Remapping does not work. You can add it by changing every pixel using
  108. ReadPixel/WritePixel. This is not too fast though. You should also skip the
  109. first four colours which are used for the standard Window/Menu look.
  110.  
  111. Speed: I've found no way how to slow down the scrolling a bit optionally. The
  112. Delay() function slows the scrolling much too much down. Any Ideas welcome!
  113.  
  114. If you have found a serious Bug, let me know about it or repair it yourself ;)
  115. but send me a copy of your work.
  116.  
  117. Ideas/Future Improvements
  118. -------------------------
  119.  
  120. As I stated in the introduction I've written this program mainly to test if it
  121. is possible, to write a system friendly scroll routine. Now I need some ideas
  122. of you what could be done with the scroll function. Some ideas from me:
  123.  
  124. - Create a BOOPSI (for me BGUI Boopsi) Class to be able to have a Scroller
  125.   Info Gadget. Critical problem: Multitasking with other gadgets (slows down
  126.   or even stops the scroller for some time if not properly implemented).
  127.  
  128. - Improve Speed and add some fancy features like sinus scrolling (any ideas ?)
  129.   (and solve the delay problem by the way :-)
  130.  
  131. - A GUI which lets you choose all necessary parameters (Width, Height, Depth,
  132.   Picture etc.) and lets the scroller optionally run on an own/public screen.
  133.  
  134. Send me your ideas and/or comments to GScroll (EMAIL prefered) and I will see
  135. what I can make out of this program. FIrst and Foremost programming hints are
  136. very welcome (for Adress see Author address section below).
  137.  
  138. Author Address
  139. --------------
  140.  
  141. E-MAIL (prefered):
  142. ------------------
  143.  
  144.   suamor@student.uni-tuebingen.de
  145.   katzmann@gemmi.informatik.uni-tuebingen.de
  146.  
  147. SnailMail:
  148. ----------
  149.  
  150.   Reinhard Katzmann
  151.   Schellingstraße 41
  152.  
  153.   D - 72072 Tübingen
  154.  
  155. BBS'es
  156. ------
  157.  
  158. You can try to reach me through BBS'es near Tübingen. Some of the Sysops
  159. might know me or have contact to the Internet. I'm only User of one BBS:
  160.  
  161. Onkel Helmut's Hütte
  162.  
  163. Line 1: (0049) +7157/64546 (28800 Baud)
  164. Line 2: (0049) +7157/65428 (14400 Baud)
  165.  
  166. My usual Nickname on the internet or at this BBS is Suamor.
  167.