home *** CD-ROM | disk | FTP | other *** search
/ Microsoft Programmer's Library 1.3 / Microsoft-Programers-Library-v1.3.iso / sampcode / alde_c / misc / func / lblcs / crt.doc < prev    next >
Encoding:
Text File  |  1985-05-08  |  14.4 KB  |  471 lines
  1.  
  2. In order to save paper, the following function descriptions are 
  3. "squashed" together.  You can use your favorite word processor
  4. to print them out, one per page, if you prefer... 
  5.  
  6.  
  7. ;------------------------------------------------------------
  8. ; name        crt_ps320sg 
  9. ;
  10. ; synopsis    crt_ps320sg(segment, offset, row, col, color)
  11. ;        int    segment;    /* 0xb000=mono    0xb800=color    */
  12. ;        int    offset;        /* use 0 for graphics adaptor    */
  13. ;        int    row;        /*  row number 0 to 199        */
  14. ;        int    col;        /*  col number 0 to 399        */
  15. ;        int    color;        /*  color      0 to 3        */
  16. ;
  17. ; description    This subroutine sets a point on the 320 x 200
  18. ;        graphics screen.  Hand coded in assembly, It
  19. ;        operates 8 - 10 times faster than the corres-
  20. ;        ponding BIOS call.  
  21. ;
  22. ; notes        This routine will treat any passed segment value 
  23. ;        like an interlaced graphics adaptor.  It could 
  24. ;        just as well be a block of memory that has been
  25. ;        allocated, (i.e. a graphics buffer that is to be moved
  26. ;        to the screen after a group of points are set ),
  27. ;        or some other segment value for a non-PC compatible
  28. ;        display.  If you are addressing the display adaptors,
  29. ;        use an offst of 0.  If you are handling a buffer, use
  30. ;        the buffers segment and offset.  Large model pointers
  31. ;        must be broken into segment and offset which are 
  32. ;        passed separately.  
  33. ;        
  34. ;        This routine handles graphics interlacing 
  35. ;        (normal IBM PC graphics).  It would not function
  36. ;        on a machine that does not interlace graphics -
  37. ;        i.e. the Tandy T2000.
  38. ;
  39. ;        If you pass the correct segment value based on the 
  40. ;        equipment flag setting, this routine will work on
  41. ;        both a color and mono display adaptor.
  42. ;         
  43. ; bugs        row, col, and color are not validated - make sure
  44. ;        they are in range or you could crash the system. 
  45. ;
  46. ;------------------------------------------------------------
  47.  
  48.  
  49. ;------------------------------------------------------------
  50. ;
  51. ; name        crt_setborder - set border color 
  52. ;
  53. ; synopsis    VOID    crt_setborder(color)
  54. ;            int    color;
  55. ;
  56. ; description    set border to specified color (0-15)
  57. ;
  58. ;------------------------------------------------------------    
  59.  
  60.  
  61. ;------------------------------------------------------------
  62. ;
  63. ; name        crt_cls - clear screen using BIOS scroll up call
  64. ;
  65. ; synopsis     VOID    crt_cls()
  66. ;
  67. ;
  68. ; description    This function clears your 80 x 24 screen using the
  69. ;        BIOS scroll up function.  For graphics uses, you
  70. ;        should use crt_scrollu with the appropriate 
  71. ;        background attribute - crt_cls assumes text mode.
  72. ;
  73. ;
  74. ; notes        This routine works only on the currently selected 
  75. ;        (active) page.  It uses the "normal" (07) attribute
  76. ;        on scrolled lines.  Unlike the CI-C86 function with
  77. ;        the same name, it does not home the cursor.   
  78. ;
  79. ;------------------------------------------------------------
  80.  
  81.  
  82.  
  83. ;------------------------------------------------------------
  84. ;
  85. ; name        crt_cls2 -- clear screen or graphics buffer
  86. ;
  87. ; synopsis    crt_cls2(segment,offset)
  88. ;            int segment;    
  89. ;            int offset;
  90. ;
  91. ;
  92. ; description    this routine uses the REP MOVSW instruction for fast
  93. ;        clearing of the screen or a graphics buffer. Use segment
  94. ;        0xb000 and offset 0 for mono, segment 0xb800 and offset
  95. ;        0 for color.  To clear a graphics buffer, use the appro-
  96. ;        priate segment and offset values.  Large model pointers
  97. ;        must be separated into segment and offset values which
  98. ;        must be passed separately.
  99. ;
  100. ; notes        on some machines, this routine is significantly faster
  101. ;        than a screen clear using the BIOS screen scroll up
  102. ;        routine.  
  103. ;
  104. ;        DI register destroyed.  ES register used and
  105. ;        then restored.
  106. ;
  107. ;        If used in text modes, it clears ALL text pages.
  108. ;------------------------------------------------------------
  109.  
  110.  
  111.  
  112. ;------------------------------------------------------------
  113. ;
  114. ; name        crt_getca - get character and attribute at cursor position
  115. ;
  116. ; synopsis    VOID    crt_getca(page)
  117. ;            int    page;
  118. ;  
  119. ; description    Reads character and attribute under cursor on
  120. ;        video page number "page". On return, character
  121. ;        in low byte ( ch = crt_getca(0) & 255), and 
  122. ;        attribute is in high byte ( atr = crt_getca(0) >> 8).
  123. ; 
  124. ; notes        use crt_gotoxy to position cursor to desired row, 
  125. ;        col, and page. 
  126. ;
  127. ;------------------------------------------------------------
  128.  
  129.  
  130. ;------------------------------------------------------------
  131. ;
  132. ; name        crt_getxy - get current cursor setting
  133. ;
  134. ; synopsis    int    crt_getxy(page)
  135. ;            int     page;
  136. ;  
  137. ; description    returns the current cursor setting in page # "page".
  138. ;        In text mode, it is possible to have up to 8 different 
  139. ;        pages, all with different cursor settings. 
  140. ;
  141. ; example    rc = crt_getxy(0);
  142. ;        column =  rc & 0xff;    /* col is lower byte        */
  143. ;        row    =  rc >> 8;    /* row is upper byte          */
  144. ;                    /* an interesting alternative    */
  145. ;                    /* to the above: row=rc % 0x100    */
  146. ;
  147. ;------------------------------------------------------------
  148.  
  149.  
  150. ;------------------------------------------------------------
  151. ;
  152. ; name        crt_gotoxy - cursor set
  153. ;
  154. ; synopsis    VOID    crt_gotoxy(row, col, page)
  155. ;            int row;
  156. ;            int col;
  157. ;            int page;
  158. ;
  159. ; description    This function does a cursor position set to 
  160. ;        row, col on the specified page.  (0--7 in 40
  161. ;        column mode; 0--3 in 80 column mode)  It does
  162. ;        not, however actually change the current text
  163. ;        page. (See crt_setpage function)
  164. ;
  165. ;------------------------------------------------------------
  166.  
  167.  
  168. ;------------------------------------------------------------
  169. ;
  170. ; name        crt_home -- home cursor on given page
  171. ;
  172. ; synopsis    VOID crt_home(page)
  173. ;            int    page;
  174. ;
  175. ; description    sets cursor to 0,0 on selected page.  This routine 
  176. ;        differs slightly from the CI-C86 function with the
  177. ;        same name - the CIC86 function always assumes page 0.
  178. ;
  179. ; notes        There is basically no difference between doing a
  180. ;        crt_home and a crt_goto to row 0, col 0. 
  181. ;
  182. ;     
  183. ;------------------------------------------------------------
  184.  
  185.  
  186.  
  187.  
  188. /************************************************************
  189.  *
  190.  * name        crt_line -- plot lines w/ BIOS point set routine
  191.  *
  192.  * synopsis    crt_line(row1,col1,row2,col2,color);        
  193.  *        int row1,col2,row2,color;
  194.  *
  195.  * description    This routine uses an octantal DDA to plot 
  196.  *        lines on your graphics screen.  The screen 
  197.  *        needs to be set to graphics mode, of course...
  198.  *
  199.  * notes    This routine is still written in 'C'.  It is faster 
  200.  *        than many of the other line draw routines I have seen
  201.  *        around, but still relatively slow compared to assembler.
  202.  *
  203.  *        Since this routine uses the BIOS point set routine,
  204.  *        it will run on color or mono display adaptors, in
  205.  *        any supported graphics mode.  The disadvantage of 
  206.  *        using the BIOS point set routine is that it is
  207.  *        extremely slow.....  The speed of this routine is
  208.  *        entirely limited by the speed of the BIOS pset call. 
  209.  * 
  210.  * bugs        Better be sure that your x and y values are in range
  211.  *        no range checking is done.
  212.  ********************************************************************/
  213.  
  214.  
  215.  
  216. /******************************************************************
  217.  *
  218.  * name        crt_line320 -- plot lines w/ fast 320x200 point routine
  219.  *
  220.  * synopsis    crt_line320(row1, col2, row2, col2, color)
  221.  *        int row1,col2,row2,col2,color;
  222.  *
  223.  * description    This routine uses a simple octantal DDA to plot 
  224.  *        lines on your 320 x 200 COLOR graphics screen.  The
  225.  *        screen needs to be set to graphics mode, of course...
  226.  *
  227.  * notes    This routine is still written in 'C'.  It is faster 
  228.  *        than many of the other line draw routines I have seen
  229.  *        around, but still relatively slow compared to assembler.
  230.  *        Next released version of the libraries will have this 
  231.  *        one written in assembler...
  232.  *
  233.  *        Works only in 320x200 color graphics mode!!
  234.  * 
  235.  * bugs        Better be sure that your x and y values are in range
  236.  *        no range checking is done.
  237.  ********************************************************************/
  238.  
  239.  
  240.  
  241. ;------------------------------------------------------------
  242. ;
  243. ; name        crt_setmode - set screen mode
  244. ;
  245. ; synopsis    VOID    crt_setmode(mode)
  246. ;            int    mode;
  247. ;
  248. ; description      Set screen to graphics or text mode.
  249. ;
  250. ;
  251. ;        TEXT MODES
  252. ;        -------------------------------
  253. ;        0    =    40 x 25  monochrome
  254. ;        1    =    40 x 25  color        
  255. ;        2    =    80 x 25  monochrome    
  256. ;        3    =    80 x 25  color        
  257. ;
  258. ;        GRAPHICS MODES
  259. ;        -------------------------------
  260. ;        4    =    320 x 200 color        
  261. ;        5    =    320 x 200 monochrome    
  262. ;        6    =    640 x 400 monochrome    
  263. ;        7    =    unknown
  264. ;
  265. ;        OTHER MODES    (some require HI-RES board)
  266. ;        -------------------------------
  267. ;        8    =    640 x 400 color        
  268. ;        9    =    640 x 400 monochrome    
  269. ;                10    =    160 x 200 color (16 colors)
  270. ;
  271. ;------------------------------------------------------------
  272.  
  273.  
  274. ;------------------------------------------------------------
  275. ;
  276. ; name        crt_getmode -- get current video mode
  277. ;
  278. ; synopsis    int    crt_getmode()
  279. ;
  280. ; description    Returns current value of mode setting.
  281. ;        See set_mode for further info about modes.
  282. ;
  283. ;------------------------------------------------------------
  284.  
  285.  
  286.  
  287. ;------------------------------------------------------------
  288. ;
  289. ; name        crt_pread -- return color of pixel on graphics screen 
  290. ;
  291. ; synopsis    int color;
  292. ;        color = crt_pread(row, col);
  293. ;        int  row, col;
  294. ;
  295. ; description    This routine reads the color of the pixel on
  296. ;        a graphics screen.  It uses the BIOS "read-a-
  297. ;        points-color" routine, so it functions on any
  298. ;        type of monitor and under all graphics modes.
  299. ;
  300. ; notes        I  have no idea what happens if you attempt to call
  301. ;        the BIOS routine with crazy row and column values.
  302. ;
  303. ;------------------------------------------------------------
  304.  
  305.  
  306.  
  307. ;------------------------------------------------------------
  308. ; name        crt_ps320 
  309. ;
  310. ; synopsis    crt_ps320(row,col,color)
  311. ;        int    row;        /*  row number 0 - 199    */
  312. ;        int    col;        /*  col number 0 - 399    */
  313. ;        int    color;        /*  color      0 - 3    */
  314. ;
  315. ; description    This subroutine sets a point on the 320 x 200
  316. ;        graphics screen.  Hand coded in assembly, It
  317. ;        operates 8 - 10 times faster than the corres-
  318. ;        ponding BIOS call.  
  319. ;
  320. ; notes        This is a COLOR ONLY routine since it assumes
  321. ;        that a color adaptor is available in the 0xb800 
  322. ;        segment.
  323. ;        
  324. ;        This routine handles graphics interlacing 
  325. ;        (normal IBM PC graphics).  It would not function
  326. ;        on a machine that does not interlace graphics -
  327. ;        i.e. the Tandy T2000.
  328. ;
  329. ;        If you need a routine that works on both mono 
  330. ;        and color, see crt_320s or crt_pset
  331. ;         
  332. ; bugs        row, col, and color are not validated -- make sure
  333. ;        they are in range or you could crash the system. 
  334. ;
  335. ; 
  336. ;
  337. ;------------------------------------------------------------
  338.  
  339.  
  340.  
  341. ;------------------------------------------------------------
  342. ;
  343. ; name        crt_pset -- use BIOS call to set point
  344. ;
  345. ; synopsis    crt_pset( row, col, color)
  346. ;        int    row,col,color;
  347. ;
  348. ; description    this routine uses the BIOS "set a point call", so it 
  349. ;        can be used in mono or color in any graphics mode.  The
  350. ;        major draw--back to using the BIOS call is that it
  351. ;        is SLOOOOW when compared to routines that set points
  352. ;        in specific graphics modes.
  353. ;
  354. ; notes        legal row, col, and color values depend on the 
  355. ;        particular graphics modes set.
  356. ;
  357. ;------------------------------------------------------------
  358.  
  359.  
  360.  
  361. ;------------------------------------------------------------
  362. ;
  363. ; name        crt_putcamult -- put multiple characters with attribute
  364. ;
  365. ; synopsis    VOID    crt_putcamult(ch, page, count)
  366. ;        int ch, page, count;
  367. ;
  368. ;  
  369. ; description    write character and attribute at current cursor location
  370. ;        high byte of ch is attribute, low byte is character
  371. ;
  372. ;        page is page # to place text on (text modes only)
  373. ;
  374. ;        Count is # of times to put character (good for top
  375. ;        and bottom of boxes).
  376. ;
  377. ;------------------------------------------------------------
  378.  
  379.  
  380. ;------------------------------------------------------------
  381. ;
  382. ; name        crt_putch -- put character only at current cursor
  383. ;
  384. ; synopsis    VOID    crt_putch(ch, page, count)
  385. ;            int ch, page, count;
  386. ;
  387. ;  
  388. ; description    Write character only at current cursor location --
  389. ;        existing attributes are used.
  390. ;
  391. ; notes        Page is page # to place text on (text modes only).
  392. ;
  393. ;        Count is # of times to put character.
  394. ;
  395. ;------------------------------------------------------------
  396.  
  397.  
  398.  
  399. ;------------------------------------------------------------
  400. ;
  401. ; name        crt_scrolld -- scroll screen down
  402. ;
  403. ; synopsis    VOID    crt_scrolld(ulrow,ulcol,lrrow,lrcol,count,attrib)
  404. ;
  405. ;        int    ulrow;        upper left row
  406. ;        int    ulcol;        upper left column
  407. ;        int    lrrow;        lower right row
  408. ;        int    lrcol;        lower right column
  409. ;        int    count;        # lines to scroll ( 0=whole window )
  410. ;        int    attrib;        attribute used on blank lines
  411. ;
  412. ; description    scrolls the window specified by "ulcol", "ulrow",
  413. ;        "lrcol", "lrrow" down by "count" lines using "attrib"
  414. ;        on each blank line.  If "count" is 0, the entire
  415. ;        screen is scrolled.
  416. ;
  417. ;------------------------------------------------------------    
  418.  
  419.  
  420. ;------------------------------------------------------------
  421. ;
  422. ; name        crt_scrollu -- scroll screen up
  423. ;
  424. ; synopsis    VOID    crt_scrollu(ulrow,ulcol,lrrow,lrcol,count,attrib)
  425. ;        int    ulrow;        upper left row
  426. ;        int    ulcol;        upper left column
  427. ;        int    lrrow;        lower right row
  428. ;        int    lrcol;        lower right column
  429. ;        int    count;        # lines to scroll ( 0=whole window )
  430. ;        int    attrib;        attribute used on blank lines
  431. ;
  432. ; description    scrolls the window specified by "ulcol", "ulrow",
  433. ;        "lrcol", "lrrow" up by "count" lines using "attrib"
  434. ;        on each blank line.  If "count" is 0, the entire
  435. ;        screen is scrolled.
  436. ;
  437. ;------------------------------------------------------------    
  438.  
  439.  
  440. ;------------------------------------------------------------
  441. ;
  442. ; name        crt_setpage -- set current text page
  443. ;
  444. ;
  445. ; synopsis    VOID    crt_setpage(page)
  446. ;            int    page;
  447. ;  
  448. ; description    Sets current active video page number to "page".
  449. ;        Used in text mode only.  Valid page #'s are 0--3 for
  450. ;        80 x 25 display and 0--7 for 40 x 25 display. 
  451. ;
  452. ;
  453. ;------------------------------------------------------------
  454.  
  455.  
  456. ;---------------------------------------------------------------
  457. ;
  458. ; name        msc_getversion    - get library version
  459. ;
  460. ; synopsis    int vers;
  461. ;        vers = msc_getversion();
  462. ;
  463. ;        printf("\nlibrary version:  %2d . %02d",vers>>8,vers&255);
  464. ;
  465. ; description:    returns library version which can be printed as in
  466. ;        the synopsis above.
  467. ;
  468. ;--------------------------------------------------------------
  469.  
  470.  
  471.