home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / progrmng / stk110.lzh / STKSRC.COM / SPR.H < prev    next >
Encoding:
C/C++ Source or Header  |  1991-02-25  |  7.9 KB  |  192 lines
  1. /**********************************************************************
  2. * spr.h
  3. *
  4. * The basic sprite support system prototypes and structures.
  5. **********************************************************************
  6.                     This file is part of
  7.  
  8.           STK -- The sprite toolkit -- version 1.1
  9.  
  10.               Copyright (C) Jari Karjala 1991
  11.  
  12. The sprite toolkit (STK) is a FreeWare toolkit for creating high
  13. resolution sprite graphics with PCompatible hardware. This toolkit 
  14. is provided as is without any warranty or such thing. See the file
  15. COPYING for further information.
  16.  
  17. **********************************************************************
  18. **********************************************************************/
  19.  
  20. #ifndef __SPR_H_
  21. #define __SPR_H_
  22.  
  23. #include "grtypes.h"
  24.  
  25. extern int spr_pass_delay;
  26. /**********************************************************************
  27. * The delay after setvisualpage() before removing old objects in
  28. * the funtion spr_next_pass(). 
  29. * Many EGA/VGA cards need some milliseconds to switch pages, 
  30. * the sprites flicker if this delay is too short.
  31. *
  32. * If someone has better solutions in dealing with this problem,
  33. * I sure would like to know about them.
  34. *
  35. * Time is given in milliseconds and the default is 10 ms for EGA
  36. * and 0 ms for Hercules (use spr_regulate_speed to balance the frame
  37. * rate with different display adapters).
  38. **********************************************************************/
  39.  
  40. #define spr_max_x gr_max_x
  41. #define spr_max_y gr_max_y
  42. /**********************************************************************
  43. * The maximum coordinate values for current graphics adapter.
  44. * Variables defined in module gr.c, and initialized in gr_start.
  45. * (It is faster to use variables instead of getmaxx() and getmaxy());
  46. **********************************************************************/
  47.  
  48. #ifndef __SPRITE_
  49. typedef void *SPRITE;
  50. #endif
  51. /**********************************************************************
  52. * The sprite type is private. The handle must be void pointer due
  53. * to the Turbo C which does not allow "struct _sprite *SPRITE" without
  54. * struct _sprite definition in the same file.
  55. **********************************************************************/
  56.  
  57. void spr_initialize(int graphicsdriver);
  58. /**********************************************************************
  59. * Initialize the sprite system to the given display hardware.
  60. * Supported graphicsdrivers: EGA (only two colors), EGAMONO and HERCMONO.
  61. * 
  62. * The visual page is set to 0.
  63. *
  64. * NOTE: This function must be called before any other sprite funtions
  65. *       and the graphics mode must have been set before this call.
  66. * 
  67. * graphicsdriver  The BGI identifier for the graphics driver used.
  68. **********************************************************************/
  69.  
  70. SPRITE spr_create(WORD w, WORD h, 
  71.                   BITMAP pic, BITMAP mask, 
  72.                   BYTE res, WORD ID);
  73. /**********************************************************************
  74. * Create a sprite from the given bitmaps.
  75. *
  76. * w,h   Width (must be < 512) and height (<256) of sprite in pixels
  77. * pic   The picture bitmap for the sprite
  78. * mask  The mask bitmap for the sprite
  79. * res   The number of steps wanted per 8 bit interval in horizontal
  80. *       direction (1,2,4,8). For example, the value 8 gives one
  81. *       pixel resolution in X-direction.
  82. * ID    The user supplied ID for the sprite (usually index into an 
  83. *       array and/or sprite type identifier).
  84. *
  85. * Return: the newly created sprite or NULL if parameter error,
  86. *           sprite too big or out-of-memory
  87. **********************************************************************/
  88.  
  89. SPRITE spr_share(SPRITE spr, BYTE n);
  90. /**********************************************************************
  91. * Create a shared version of the given sprite. This allows at
  92. * most n spr_copies which all share the shape data thus saving
  93. * quite much memory.
  94. *
  95. * spr   The sprite to share
  96. * n     The maximum number of shared copies
  97. *
  98. * Return: New SPRITE or NULL if error (out of memory, spr==NULL)
  99. **********************************************************************/
  100.  
  101. SPRITE spr_copy(SPRITE spr, WORD id);
  102. /**********************************************************************
  103. * Create a copy of the given sprite. If the sprite was shared
  104. * with spr_share then a shared copy is created. 
  105. *
  106. * spr   The sprite to share
  107. * id    The ID for the new sprite
  108. *
  109. * Return: New SPRITE or NULL if error (out of memory, spr was NULL, 
  110. *           no more shared copies)
  111. **********************************************************************/
  112.  
  113. void spr_put(SPRITE spr, WORD x, WORD y);
  114. /**********************************************************************
  115. * Put the sprite into the given position in the display. 
  116. * Actually the call has no effect on screen until spr_next_pass() is
  117. * called next time and the sprite will disappear after the next
  118. * spr_next_pass() call after that.
  119. *
  120. * NOTE: Cannot be called twice for the same sprite before spr_hide() or
  121. *       spr_next_pass().
  122. *
  123. * spr   The sprite to put
  124. * x     The X coordinate
  125. * y     The Y coordinate
  126. **********************************************************************/
  127.  
  128. void spr_hide(SPRITE spr);
  129. /**********************************************************************
  130. * Undo a spr_put for the sprite. This function only removes the sprite
  131. * from internal display list since the spr_put did not actually put the 
  132. * sprite into the screen.
  133. *
  134. * spr   The sprite to hide
  135. **********************************************************************/
  136.  
  137. void spr_delete(SPRITE spr);
  138. /**********************************************************************
  139. * Delete the given sprite and release associated memory buffers.
  140. * Also spr_hides the sprite.
  141. *
  142. * spr   The sprite to delete
  143. **********************************************************************/
  144.  
  145. WORD spr_next_pass(void);
  146. /**********************************************************************
  147. * 1. Draw all sprites into the hidden screen page.
  148. * 2. Make the hidden screen page visible.
  149. * 3. Delete old sprites from the new hidden page.
  150. *
  151. * Return: The current visual page number
  152. **********************************************************************/
  153.  
  154. void spr_regulate_speed(void);
  155. /**********************************************************************
  156. * This function tries to regulate the frame speed by delaying if
  157. * we are doing more frames per second than we should. The target 
  158. * speed is 1 frame per one clock tick (about 18 frames per second).
  159. * This is a reasonable target speed for 286 machines.
  160. * This function should be called after each spr_next_pass() call.
  161. **********************************************************************/
  162.  
  163.  
  164. /***** Information retrieving functions *****/
  165.  
  166. WORD spr_get_id(SPRITE spr);
  167. /**********************************************************************
  168. * Return the user supplied identifier of the sprite
  169. **********************************************************************/
  170.  
  171. WORD spr_get_x(SPRITE spr);
  172. /**********************************************************************
  173. * Return the X coordinate of the sprite in pixels from top-left
  174. **********************************************************************/
  175.  
  176. WORD spr_get_y(SPRITE spr);
  177. /**********************************************************************
  178. * Return the Y coordinate of the sprite in pixels from top-left
  179. **********************************************************************/
  180.  
  181. WORD spr_get_width(SPRITE spr);
  182. /**********************************************************************
  183. * Return the width of the sprite in pixels
  184. **********************************************************************/
  185.  
  186. WORD spr_get_height(SPRITE spr);
  187. /**********************************************************************
  188. * Return the height of the sprite in pixels
  189. **********************************************************************/
  190.  
  191. #endif
  192.