home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / wst!blz1.dms / in.adf / docs / rilibdocs.lha / RIAnimLib.doc < prev    next >
Encoding:
Text File  |  1994-09-05  |  3.5 KB  |  96 lines
  1. Library Name:
  2.   rianimlib #57
  3.  
  4. Authors:
  5.   ReflectiveImages, 17 Mayles Road, Southsea, Portsmouth, Hampshire, UK PO4 8NP
  6.  
  7. OverView:
  8.   Another Reflective Images Library, looks pretty useful this one...
  9.  
  10. Authors Docs:
  11.  
  12. RIAnim Library v1.0
  13. ===================
  14.  
  15. By Stephen McNamara
  16. (c)1994 Reflective Images
  17.  
  18. This library enables the playback of both Anim5 and Anim7 format
  19. animations.  It allows you to playback animations at any co-ordinate in a
  20. bitmap and supports different palettes for frames of the animation.  It
  21. also allows you to playback animations from FAST ram, thus you can now play
  22. massive animations that can only fit in FAST ram.
  23.  
  24. When playing back animations you must make sure that your display is
  25. double-buffered.  Please refer to the Blitz manual for information about
  26. how anims can be played back properly - or look at the example program
  27. included with this file.
  28.  
  29. Note: there may still be a few bugs in the animation playback routines - if
  30. you have any problems or spot any bugs then please contact us at the
  31. address given in the main file of this archive.
  32.  
  33.  
  34. Command list:
  35.     [suc=]RIAnimInit(address,bitmap#,palette#[,xy_offset])
  36.     [suc=]RINextAnimFrame bitmap#
  37.     AnimLoop
  38.  
  39. Statement/Function: RIAnimInit
  40. ------------------------------------------------------------------------
  41. Modes : Amiga/Blitz
  42. Syntax: [suc=]RIAnimInit(address,bitmap#,palette#[,xy_offset])
  43.  
  44.   This command attempts to take an animation held in memory (CHIP or FAST)
  45. and identify it as a supported animation format.  If it identifies it okay
  46. it will set up the animation by unpacking frame 1 of the anim onto the
  47. specified bitmap and copying the palette to the specified palette object.
  48. You must ensure that the bitmap is big and deep enough to actually hold the
  49. animation.  At the moment there is no checking of the bitmap size.  The
  50. palette object you give is automatically resized to the size of the palette
  51. in the animation.
  52.  
  53.   The optional parameter allows you to play an animation at an offset into
  54. a bitmap.  Thus you could center a half screen animation on a bitmap.  The
  55. offset is given as a byte offset from the start of each bitplane.  It is
  56. calculated like this:
  57.  
  58.       offset=(X/8)+(Y*(pixel_width/8))
  59.  
  60.       where: X and Y are your co-ordinates
  61.              pixel_width is the width of your bitmap.
  62.  
  63.   If used as a function, this command returns true for a successful
  64. initialise or false for failure.
  65.  
  66.  
  67. Statement/Function: RINextAnimFrame
  68. ------------------------------------------------------------------------
  69. Modes : Amiga/Blitz
  70. Syntax: [suc=]RINextAnimFrame bitmap#
  71.  
  72.   This command attempts to unpack the next frame of a previously
  73. initialised animation onto the specified bitmap.  It returns true or false
  74. to say whether it succeeded or not.
  75.  
  76.  
  77. Statement: AnimLoop
  78. ------------------------------------------------------------------------
  79. Modes : Amiga/Blitz
  80. Syntax: AnimLoop ON|OFF
  81.  
  82.   This command allows you to control the looping mode of the animation.
  83. With animloop off, playback of an animation will stop at the last frame of
  84. it.  Any attempt to draw another frame will fail.  With it on, though, the
  85. animation will loop around.
  86.  
  87.   Note: you must ensure that your animation has loop frames at the end of
  88. it if you want to loop the animation around.  The reverse of this is true
  89. for animloop off - the animation must not have loop frames if you don't
  90. want it to loop around.  If you select animloop off but have looping frames
  91. in your anim then the animation will end by displaying a copy of frame 2
  92. of the animation.
  93.  
  94.  
  95. >> END
  96.