home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / programming / amos / lturbo / docs / new_commands_doc.asc < prev   
Encoding:
Text File  |  1980-08-29  |  9.0 KB  |  236 lines
  1. *************************************************************************
  2. *                                    *
  3. *            AMOS 1.3 TURBO extension library    v1.6        *
  4. *                                               *
  5. *                                    *
  6. *                                    *
  7. *    MANUEL ANDRE                            *
  8. *    Prins Boudewijnlaan 155/5                    *
  9. *    2610    WILRIJK                            *
  10. *                                    *
  11. *    BELGIUM                                *
  12. *                                    *
  13. *                                    *
  14. *    DIAL    03/449.54.18                        *
  15. *                                    *
  16. *************************************************************************
  17.  
  18. %%%  !!!! To all users : read this doc-file carefully...      !!!! %%%
  19. %%%  !!!! This doc includes all new commands and can be used to  !!!! %%%
  20. %%%  !!!! have a quick view at them.                 !!!! %%%
  21. %%%  !!!! They will be included in the main doc file when a newer!!!! %%%
  22. %%%  !!!! version is released.                     !!!! %%%
  23.  
  24.  
  25. Object Limit X :
  26.     Sets the maximum amount of objects. You MUST set the limit 
  27.     before you can reserve and define the objects.
  28.     When X is set to zero, the OBJECT structure is erased from
  29.     memory.
  30.     In the previous versions of TURBO and TEST EXTENSION you
  31.     could define max. 32 objects. Now there are no more limits !
  32.     You can define upto 32.000 objects.
  33.     Old object files are compatible with the new ones !
  34.  
  35. F Draw X,Y : 
  36.     Does the same thing as Draw To X,Y. But it is up to 200% faster
  37.     than the original Draw routine ! (1-2 bitplane screen)
  38.     The Set Line MASK command has no effect when using F Draw, this
  39.     will be corrected in the next version !
  40.  
  41. F Draw X,Y To X1,Y1 :
  42.     Does the same thing as Draw X,Y To X1,Y1. But it is up to 200%
  43.     faster than the original Draw routine ! (2 bitplane screen)
  44.     The Set Line MASK command has no effect when using F Draw, this
  45.     will be corrected in the next version !
  46.  
  47. Set Planes MASK :
  48.     Restricts most drawing operations to a number of bitplanes, defined
  49.     by the MASK parameter.
  50.     Each bit represents a bitplane.
  51.       Ex.: Set Planes %101, enables planes 1 and 3.
  52.     Allways remember to reset the value to 255, else some strange things
  53.     might happen with the editor window.
  54.     All the new BLITTER commands use this parameter !
  55.  
  56. Plane Offset SCRNR,PLANENR,XOFFSET,YOFFSET :
  57.     Sets the offset for a particular bitplane used by screen SCRNR.
  58.     X should allways be even, allthough an uneven value is possible.
  59.     This command can be used to program some interesting effects such
  60.     as interference without having to use the dual playfield mode or
  61.     the Screen Copy commands !
  62.     To set all offsets for all planes to zero, you should use the 
  63.     Plane Offset command with a negative PLANENR parameter.  This is
  64.     because I store the offset for each particular plane.
  65.     To reset the offset of a particular plane, set the X and YOFFSET
  66.     parameters to zero.
  67.       Ex.: to reset all offsets of screen 3 --> Plane Offset 3,-1,0,0
  68.            to reset plane two of screen 1   --> Plane Offset 1,2,0,0
  69.     See Plane Update for further information.
  70.  
  71. Plane Swap SCRNR,PLANE1,PLANE2 :
  72.     Swap PLANE1 with PLANE2  of screen SCRNR. Again a very powerfull
  73.     command !
  74.     See Plane Update for further information.
  75.  
  76. Plane Shift Up SCRNR,START To END :
  77.     Shifts the planes up by 1 from START to END used by screen SCRNR.
  78.       Ex.:  PLANE1 = 50000
  79.         PLANE2 = 60000
  80.         PLANE3 = 70000
  81.         PLANE4 = 80000
  82.  
  83.         Plane Shift Up 1 To 3
  84.  
  85.         PLANE1 = 70000
  86.         PLANE2 = 50000
  87.         PLANE3 = 60000
  88.         PLANE4 = 80000
  89.     See Plane Update for further information.
  90.  
  91. Plane Shift Down SCRNR,START To END
  92.     Does the opposite thing of Plane Shift Up...
  93.     See Plane Update for further information.
  94.  
  95. Plane Update SCRNR :
  96.     This command is used to reflect the changes made with the Plane
  97.     commands.  Normally you could use the AMOS View command to
  98.     display what is changed.
  99.     This is true for all Plane commands except the Plane Offset command.
  100.     The Plane Offset command was only made possible thru some clever
  101.     programming !  In fact I don't change the bitplane addresses at
  102.     all...
  103.     This is why you should use Plane Update instead of the AMOS View
  104.     command.
  105.  
  106. F Paste Icon X,Y,ICON :
  107.     This a highly optimised general purpose icon routine.
  108.     The X coordinate is chopped to ly on a 16 bit boundary, and
  109.     only partial clipping is supported.
  110.     It can handle Icons of variable size.
  111.     If X < 0 no Icon is displayed.
  112.     If Y < 0 no Icon is displayed.
  113.     If X > width of screen, no Icon is displayed.
  114.     If Y > height of screen, no Icon is displayed.
  115.     If X < width of screen but X+width of Icon > width of screen,
  116.     the Icon is partially displayed. (clipped)
  117.     If Y < height of screen but Y+height of icon > heigth of screen,
  118.     the Icon is partially displayed. (clipped)
  119.     This routine is generally 2-3.5 times faster than the AMOS 
  120.     original one !
  121.  
  122. F 16 Icon X,Y,ICON :
  123.     This is a highly optimised special purpose Icon routine.
  124.     This routine can only be used to display Icons that are 16 pixels
  125.     wide.
  126.     The Icon Bank must be loaded with Icons and all Icons must be
  127.     defined, if not a crash is possible !
  128.     I've disgarded all testing for best speed possible !
  129.     The X and Y coordinates are chopped to ly on a 16 bit boundary, and
  130.     only partial clipping is supported.
  131.     If X < 0 no Icon is displayed.
  132.     If Y < 0 no Icon is displayed.
  133.     If X > width of screen no Icon is displayed.
  134.     If Y > height of screen no Icon is displayed.
  135.     This routine is generally 3-4.5 times faster than the AMOS 
  136.     original one !
  137.  
  138. F 32 Icon X,Y,ICON :
  139.     This is a highly optimised special purpose Icon routine.
  140.     This routine can only be used to display Icons that are 32 pixels
  141.     wide.
  142.     The Icon Bank must be loaded with Icons and all Icons must be
  143.     defined, if not a crash is possible !
  144.     I've disgarded all testing for best speed possible !
  145.     The X and Y coordinates are chopped to ly on a 32 bit boundary, and
  146.     only partial clipping is supported.
  147.     If X < 0 no Icon is displayed.
  148.     If Y < 0 no Icon is displayed.
  149.     If X > width of screen no Icon is displayed.
  150.     If Y > height of screen no Icon is displayed.
  151.     This routine is generally 2-3.5 times faster than the AMOS 
  152.     original one !
  153.  
  154. F 16proc Icon X,Y,ICON :
  155.     This is a highly optimised special purpose Icon routine.
  156.     I don't use the BLITTER to put the Icon onto the screen.
  157.     The MC680X0 processor is used instead !
  158.     The people who have a fast processor (68020+) can take advantage
  159.     of this routine to display the Icons faster than the BLITTER !
  160.     This routine is even faster than the normal AMOS routine, which
  161.     uses the BLITTER, if executed with a slower (68000/68010) processor !
  162.     It is in most cases faster than the F 16 Icon routine !
  163.     People with a slower (68000/68010) processor should not use 
  164.     this routine.
  165.     This routine can only be used to display Icons that are 16 pixels
  166.     wide.
  167.     The Icon Bank must be loaded with Icons and all Icons must be
  168.     defined, if not a crash is possible !
  169.     I've disgarded all testing for best speed possible !
  170.     The X and Y coordinates are chopped to ly on a 16 bit boundary, and
  171.     only partial clipping is supported.
  172.     If X < 0 no Icon is displayed.
  173.     If Y < 0 no Icon is displayed.
  174.     If X > width of screen no Icon is displayed.
  175.     If Y > height of screen no Icon is displayed.
  176.     This routine is generally 3-5 times faster than the AMOS 
  177.     original one !    (A1200 14 Mhz/ CACHE ON / NO FASTRAM)
  178.  
  179. F 32proc Icon X,Y,ICON :
  180.     This is a highly optimised special purpose Icon routine.
  181.     This routine can only be used to display Icons that are 32 pixels
  182.     wide.
  183.     The Icon Bank must be loaded with Icons and all Icons must be
  184.     defined, if not a crash is possible !
  185.     I've disgarded all testing for best speed possible !
  186.     I don't use the BLITTER to put the Icon onto the screen.
  187.     The MC680X0 processor is used instead !
  188.     The people who have a fast processor (68030+) can take advantage
  189.     of this routine to display the Icons faster than the BLITTER !
  190.     People with a slower (68000/68010/68020) processor should not use 
  191.     this routine.
  192.     The X and Y coordinates are chopped to ly on a 32 bit boundary, and
  193.     only partial clipping is supported.
  194.     If X < 0 no Icon is displayed.
  195.     If Y < 0 no Icon is displayed.
  196.     If X > width of screen no Icon is displayed.
  197.     If Y > height of screen no Icon is displayed.
  198.     This routine is generally 2-3 times faster than the AMOS 
  199.     original one !  (A1200 14 Mhz/ CACHE ON / NO FASTRAM)
  200.  
  201. !!!!    Why have I made the F 16proc Icon and F 32proc Icon routines?   !!!!
  202. !!!!    Like all of the TURBO EXTENSION commands they are made just     !!!!
  203. !!!!    for the fun of it.  To get the best speed on all AMIGA's you    !!!!
  204. !!!!    should use the F Paste Icon/F 16 Icon/ F 32 Icon commands.      !!!!
  205. !!!!    They use the BLITTER instead of the main cpu.                   !!!!
  206.  
  207.  
  208. R=X Icon(nr) :
  209.     This function returns the width (in words) of a particular Icon.
  210.  
  211.  
  212. R=Y Icon(nr) :
  213.     This fuction returns the height (in lines) of a particular Icon.
  214.  
  215. R=Planes Icon(nr) :
  216.     This function returns how many planes the Icon is made of.
  217.     Ex.: Screen Open 0,320,200,8,Lowres
  218.          Get Icon 1,0,0 To 64,100
  219.          DEPTH=Planes Icon(1)
  220.          'DEPTH will contain 3 --> 8 colours need 3 bitplanes...
  221.  
  222. R=Cpu Info :
  223.     This function returns what cpu-type is in your AMIGA.
  224.         00    plain 68000
  225.         10    68010 processor
  226.         20    68020 processor
  227.         30    68030 processor
  228.         40    68040 processor
  229.  
  230. R=Math Info :
  231.     This functions returns what type of math coprocessor you have
  232.     in your AMIGA.
  233.         000    no coprocessor installed
  234.         881    MC68881 coprocessor installed
  235.         882     MC68882 coprocessor installed
  236.