home *** CD-ROM | disk | FTP | other *** search
/ Shareware Supreme Volume 6 #1 / swsii.zip / swsii / 279 / RM08.ZIP / RM.DOC < prev    next >
Text File  |  1993-01-27  |  12KB  |  340 lines
  1.                        Raster Master V3.4
  2.  
  3.           (c) Copyright 1991-93 by Scarborough Digital.
  4.                       All Rights Reserved. 
  5.  
  6.  
  7.  
  8.  
  9.  
  10. INTRODUCTION
  11.  
  12.   Raster Master is a powerful graphic editor that allows
  13. programmers and developers to create and manipulate small images.
  14. Raster Master can edit images from 1X1 pixel up to 100X100
  15. pixels. Images can be saved in standard PCX format or as source
  16. code making it easy to add to your programs.  Raster Master was
  17. designed to work in conjunction with other toolkits and graphic
  18. libraries such as Fastgraph and TEGL Windows Toolkit as well as
  19. the standard graphic libraries for Turbo C, QuickC, Turbo Pascal,
  20. and QuickBasic.  Additional BMP and ICO formats are supported for
  21. Windows 3.
  22.  
  23.  
  24. REQUIREMENTS
  25.  
  26.   VGA Card, SVGA optional for the 256 color mode
  27.   Mouse
  28.   DOS 3.0 or higher
  29.  
  30.  
  31. USING THE EDITOR
  32.  
  33. OPEN/SAVE:  Click in the FILENAME area and type in the name.
  34.  
  35. Any FILE in the FILE LISTING can be selected by simply pointing
  36. to it.
  37.  
  38. DIRECTORIES can be accessed in one of two ways.  Either by
  39. changing the contents of the DIRECTORY area or pointing to the
  40. actual directory in the listing.
  41.  
  42. CHANGING THE OPEN FORMAT: Press the RIGHT mouse button over the
  43. OPEN gadget. 
  44.  
  45. CHANGING THE SAVE FORMAT: Press the RIGHT mouse button over the
  46. SAVE gadget.
  47.  
  48. Use the up and down gadgets to select the new format.
  49.  
  50.  
  51.  
  52.  CLR       Clears the screen.
  53.  
  54.  UNDO      Deletes last step taken.
  55.  
  56.  GRID      Toggles the grid ON/OFF.
  57.  
  58.  SIZE      Allows you to select the size of the zoom area.
  59.            25x25, 50x50, 100x100 pixels are supported.  The
  60.            scrollers can be used to move to different areas
  61.            of the image when in the 25x25 or 50x50 zoom mode.
  62.  
  63.  VIEW      Previews  drawing in one of the listed resolutions.
  64.  
  65.  MODE      Toggles between 16 and 256 color mode.
  66.            Note: ONLY registered users will be given the
  67.            opportunity to save their images in the 256
  68.            color mode.
  69.  
  70.  EXIT      Exits Raster Master.
  71.  
  72.  CLIP      Switches to clip mode allowing you perform the        
  73.            following functions.
  74.  
  75.            OPEN/SAVE: Works the same way as the OPEN/SAVE
  76.                       described above.  When OPENing/Saving,
  77.                       only the clipped area will be affected.
  78.  
  79.            HFLIP/VFLIP: Horizontally/vertically flips the
  80.                         clipped image.
  81.  
  82.            LEFT/RIGHT/UP/DOWN:  Scrolls the clipped image in
  83.                                 the appropriate direction.
  84.  
  85.            EXIT:  Returns to the main menu.
  86.  
  87.  
  88. DRAWING TOOLS
  89.  
  90.       FREEHAND DRAWING  Move the pointer inside the zoom area and
  91.                         click to plot a pixel.
  92.  
  93.       SPRAY PAINT  Randomly plot pixels until release of mouse   
  94.                    button.
  95.  
  96.       FLOOD PAINT  Fills an enclosed area with the current
  97.                    color. 
  98.  
  99.       ALL remaining tools work by selecting the starting point,
  100.       dragging the mouse, then releasing the mouse button.
  101.  
  102.  
  103. SELECTING COLORS
  104.  
  105. Simply select  the color of your choice.  In the 256 color mode
  106. you can scroll through the remaining colors by pressing on the up
  107. or down gadgets.
  108.  
  109.  
  110. PALETTE EDITING
  111.  
  112. Press the PAL gadget, select a color, use the RGB scrollers and
  113. gadgets to modify the color.
  114.  
  115.  
  116. ADDING GRAPHICS TO YOUR PROGRAMS
  117.  
  118.   One of the great features of Raster Master is its ability
  119.   create images compatible with the standard graphic libraries
  120.   included with Turbo C, QuickC, Turbo Pascal, and QuickBASIC.
  121.   Raster Master also supports additional libraries like Fastgraph
  122.   and TEGL Windows Toolkit.  Source code can be generated for    
  123.   images, palettes, and mouse pointers.
  124.  
  125.  
  126. 1.  RM RAW               - Raster Master's RAW format.
  127.  
  128. 2.  Palette              - Binary format containing RBG values.
  129. 3.  Palette (C)          - Source code in C for the palette.
  130. 4.  Palette (PAS)        - Source code in Pascal for the palette.
  131. 5.  Palette (BAS)        - Source code in BASIC for the palette.
  132.  
  133. 6.  TP/TC (Binary)       - Turbo C/Pascal binary image format to
  134.                            be displayed with the putimage        
  135.                            function.
  136.                      
  137.                            see Demo1.c for Turbo C
  138.                            see Demo1.pas for Turbo Pascal
  139.                            For 256 color images you must use the
  140.                            supplied SVGA256.bgi driver.
  141.  
  142.  
  143. 7.  TP Constants         - Turbo Pascal source code for format 6
  144.                            see Demo2.pas
  145.  
  146. 8.  TC Constants         - Turbo C source code for format 6
  147.                            see Demo2.c
  148.  
  149. 9.  QC/QB (Binary)       - QuickC/BASIC binary image format to be
  150.                            displayed with _putimage (QC) or PUT  
  151.                            (QB).
  152.                            See Demo3.c for QuickC
  153.                            See Demo1.bas for QuickBASIC
  154.  
  155.  
  156. 10. QC Constants         - QuickC source code for format 9
  157.                            see Demo4.c
  158.  
  159. 11. BASIC DATA           - QuickBASIC source code for format 9
  160.                            see Demo2.bas
  161.  
  162. 12. TEGL DEF             - TEGL Windows Toolkit text based HEX   
  163.                            format
  164.                            Refer to manual and TEGL code for DEF.
  165.  
  166.  
  167.  
  168. 13. PPR  Fastgraph       - Fastgraph Packed Pixel Run format. 16
  169.                            colors or less.
  170.  
  171. 14. SPR  Fastgraph       - Fastgraph Single Pixel Run format. max
  172.                            256 colors.
  173.  
  174. 15. FG PPR (C)           - C code for format 13
  175. 16. FG SPR (C)           - C code for format 14
  176. 17. FG PPR (PAS)         - Pascal code for format 13
  177. 18. FG SPR (PAS)         - Pascal code for format 14
  178. 19. FG PPR (BAS)         - Basic code for format 13
  179. 20. FG SPR (BAS)         - Basic code for format 14
  180.  
  181.  
  182.                           Refer to the Fastgraph user and        
  183.                           reference manuals.                     
  184.                           Use the included program xinfo.exe to  
  185.                           obtain the run count and width from    
  186.                           Raster Master created  SPR and PPR    
  187.                           files.
  188.  
  189.  
  190.  
  191.  
  192. 21. Mouse (C)            - C code for mouse image.
  193. 22. Mouse (PAS)          - Pascal code for mouse image.
  194. 23. Mouse (BAS)          - Basic code for mouse image
  195.  
  196.  
  197.  
  198.                           When saving in this format only the    
  199.                           first 16X16 pixels from the left top   
  200.                           corner will be saved. If the image is  
  201.                           clipped only the first 16X16
  202.                           pixels starting from the top left      
  203.                           corner of the clipped image will be    
  204.                           saved.
  205.  
  206.  
  207.                           The colors black, white, and dark blue
  208.                           are used to build the mouse image. Dark
  209.                           blue will be considered transparent.   
  210.                           Any other color is used to indicate that
  211.                           the screen pixel under the mouse image 
  212.                           will be inverted. 
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220. THE 'RAW' FORMAT
  221.  
  222.   Raster Master supports its own format for saving and retrieving
  223. files.  The format is broken up into three main parts. The
  224. Header, Palette, and Image portions.
  225.  
  226.                        ---  HEADER  ---
  227. Bytes
  228. -----
  229. 1 , 2 - Width of Image
  230. 3 , 4 - Height of Image
  231. 5 , 6 - Number of Colors - if 0 image does not contain a palette
  232.  
  233.                       ---  PALETTE  ---
  234.  
  235. 7 , 8 , 9  - Red, Green, Blue values of the first color.
  236.              The values will range from 0 to 63. Each additional
  237.              three bytes indicate the values of the next color.  
  238.              For an image that contains 16 colors the PALETTE    
  239.              size will be 48 bytes (3*16).  
  240.  
  241.                         ---  IMAGE ---
  242.  
  243. What ever follows after the palette is the actual image. The
  244. first byte following the palette will be the first pixel starting
  245. from the left top corner. The remaining pixels follow row by row.
  246. Each pixel takes exactly one byte no matter how many colors there
  247. are in the image.
  248.  
  249.  
  250. THE API
  251.  
  252.   Raster Master also supports additional formats with its tiny
  253. API system.  Raster Master does this by allowing the programmer
  254. to write a conversion program that will be executed automatically
  255. when the format is selected. When selecting the change format
  256. option (RIGHT mouse over OPEN or SAVE) Raster Master will look
  257. for a file called RM.FIL. This is a standard TEXT file that will
  258. contain the parameters of your conversion program. Lets say you
  259. want to write a conversion program that will save your image as a
  260. GIF file. The first line of RM.FIL should be:
  261.  
  262. RAW2GIF.EXE GIF 1 W CIS GIF FORMAT
  263.    |         |  | | |_________________  Format Description 
  264.    |         |  | |
  265.    |         |  | |___________________  Read/Write
  266.    |         |  |  
  267.    |         |  |_____________________  Format Number            
  268.    |         |
  269.    |         |________________________  Format Extension
  270.    |
  271.    |__________________________________  Filename                 
  272.                           
  273.                                        
  274. FILENAME of conversion program must 12 characters or less.
  275. FORMAT EXTENSION must be 3 characters or less
  276. FORMAT NUMBER must be 3 character or less
  277. FORMAT TYPE must 1 character. Either 'W' OR 'R'. The W indicates
  278.             that the listed format will only appear in the 'Save
  279.             format menu.'  The R indicates that it will appear in
  280.             the 'open format menu.'
  281. FORMAT DESCRIPTION must be 20 characters or less
  282.  
  283. The FORMAT EXTENSION is required by the file requester to list
  284. the appropriate files.
  285.  
  286. The FORMAT number is what will be passed to your conversion
  287. program in the command line parameters.  One conversion program
  288. can have more than one input and/or output format(s).
  289.  
  290. The conversion program will be executed by Raster Master in the
  291. following manner when a file is being saved:
  292.  
  293. RAW2GIF.EXE <FILENAME> <FORMAT NUMBER>
  294.  
  295. Once your conversion takes over there will be a file called
  296. RM$$.RAW in the current directory that it must convert to the
  297. specified format and name. The RM$$.RAW file is saved just like
  298. the previously described RAW format. The RM$$.RAW file will be
  299. deleted by Raster Master automatically after your conversion
  300. program is through with it.
  301.  
  302. If your going to write a conversion program that reads an image
  303. into Raster Master you must create the RM$$.RAW file from your
  304. original format. Raster Master passes the following parameters
  305. when executing a conversion program for reading an image.
  306.  
  307. GIF2RAW <FILENAME> <FORMAT NUMBER> <X> <Y> <X2> <Y2> <PAL>
  308.  
  309. The additional information indicates the co-ordinates that the
  310. image will be displayed in. If the <PAL> value is 1 it means that
  311. you may include a palette in the RM$$.RAW file. If 0 it means
  312. that a palette is not required and will not be used.
  313.  
  314. Your conversion program should not display any kind of messages.
  315.  
  316.  
  317.  
  318.  
  319.  
  320. REGISTERED USERS
  321.  
  322.  The format of the key file has been changed from versions before
  323. 3.0. You can upgrade your key by sending a filled registration
  324. form along with $5. Include the word upgrade in the
  325. comments/suggestion area. The change was made because of the new
  326. format Raster Master is released under.  The key file should be
  327. placed in the same directory as your RM.EXE file.
  328.  
  329.  
  330. REGISTERING
  331.  
  332.  Raster Master is NOT free software. If you use this program you
  333. must pay for it. Registration entitles you to a key file that
  334. removes the delay screen and enables features not found in the
  335. "test drive" version. You will also receive the latest version of
  336. the program and any other utility programs we decide to include
  337. with the registered version.  Raster Master is updated constantly
  338. with new features being added all the time. See ORDER.TXT. 
  339.  
  340.