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