src/lib/modex/paledit/paledit.doc

   1  \r
   2 PALEDIT - A Simple VGA 256 Color Palette Editor\r
   3  \r
   4  \r
   5 PALEDIT is distributed with MODEXnnn.ZIP, the general purpose MODE X\r
   6 Library for VGA Graphics.\r
   7  \r
   8 WHAT YOU NEED TO RUN PALEDIT:\r
   9  \r
  10     * A Vga Monitor\r
  11     * A Microsoft Compatible Mouse\r
  12  \r
  13     A Mouse is most definitely required, as the keyboard is used for\r
  14     nothing except entering file names.\r
  15  \r
  16 FILES NEEDED IN THE CURRENT DIRECTORY:\r
  17  \r
  18     PALEDIT.EXE  - The Palette Editor Program\r
  19     CHARSETS.CS  - The Palette Editor's Internal Fonts\r
  20     MOUSEIMG.CS  - The Palette Editor's Mouse Pointer\r
  21  \r
  22 SAMPLE PALETTE FILE THAT SHOULD BE INCLUDED:\r
  23  \r
  24      RGB.PAL   - A Simple Palette with Reds, Greens, and Blues\r
  25      PRIME.PAL    - A Simple Palette\r
  26      GAMECOLR.PAL - A Bright Palette from a Game of mine.\r
  27  \r
  28 WHAT IT EDITS:\r
  29  \r
  30      The VGA DAC Registers, all 256 of them.\r
  31  \r
  32 HOW IT WORKS/FEATURES:\r
  33  \r
  34     PALEDIT allows the user to see the entire VGA Palette of 256 colors\r
  35     and select and modify the RED, GREEN, and BLUE values of any individual\r
  36     color (DAC) register.  The entire group of 256 colors can be saved to\r
  37     a disk file for later retrieval.\r
  38  \r
  39     Individual "SLIDERS" show the current RED, GREEN, and BLUE color\r
  40     components of the current color and allow them to be changed.\r
  41  \r
  42     The Following operations can be performed.\r
  43  \r
  44     * Raise, Lower, and set the RED, GREEN, or BLUE components.\r
  45     * Copy the current RGB values to another Color (DAC) Register\r
  46     * Brighten the selected color\r
  47     * Darken and selected color\r
  48     * Reset the selected color to its original state\r
  49     * Blend an entire range of colors, creating a smooth\r
  50       Transition from one color to another\r
  51     * Optionally Lock out the first 16 colors to prevent\r
  52       Accidental Modification\r
  53  \r
  54 DESCRIPTION OF OBJECTS/FEATURES FROM THE TOP DOWN:\r
  55  \r
  56     COLOR SLIDERS:  In the upper left of the screen there are\r
  57         Three Rectangular Boxes: One for each primary color:\r
  58         RED, GREEN, and BLUE.  Each Box has an arrow at each\r
  59         end, and a scale bar in the middle, connecting the two\r
  60         arrows.  The scale bar is much like a thermometer,\r
  61         indicating how much of that color is in the selected\r
  62         color.  To the right of each Box, the name of the color\r
  63         is indicated, along with the content color in the form\r
  64         of a number from 0 to 63; where 0 means none of that\r
  65         color goes into making the selected color, and 63 means\r
  66         that the selected color is saturated with that color.\r
  67  \r
  68         Clicking the mouse on the slider's left arrow box will\r
  69         decrease the amount of that primary color in the selected\r
  70         color.  Holding the mouse button down will reduce the\r
  71         color value all the way to 0.\r
  72  \r
  73         Clicking the mouse on the slider's right arrow box will\r
  74         increase the amount of that primary color in the selected\r
  75         color.  Holding the mouse button down will increase the\r
  76         color value all the way to 63.\r
  77  \r
  78         Clicking the mouse on the scale bar will set the amount\r
  79         of that primary color to the value the represents that\r
  80         position on the slider.\r
  81  \r
  82     LOCK Button:  Clicking the button toggles the lockout of the\r
  83         first 16 colors.  When they are locked out, they can not\r
  84         be modified, and when selected the word "LOCKED" will\r
  85         appear below the color # on the Color Information Display.\r
  86  \r
  87     LOAD Button:  Clicking this button will load the Palette file\r
  88         that is named in the Palette File name box.  If no name is\r
  89         given or no such file exists, then nothing will be loaded.\r
  90  \r
  91     SAVE Button: Clicking this button will save the current Palette\r
  92         in a file using the name given in the Palette File Name Box.\r
  93         If a Valid name is not provided, nothing will be saved.\r
  94  \r
  95     QUIT Button: Clicking this button will return you to DOS.\r
  96         Nothing is saved, and no confirmation is given.\r
  97  \r
  98  \r
  99     Color Information Display:  This Box is on the left side of the\r
 100         Screen, below the Color Sliders.  It shows the number of the\r
 101         currently selected color (from 0 to 255) and indicates if\r
 102         that color is locked.  To the right of this box is a big\r
 103         square showing the current color.\r
 104  \r
 105     LIGHTER Button:  Clicking this button will make the selected\r
 106         color brighter.\r
 107  \r
 108     DARKER Button:  Clicking this button will make the selected\r
 109         color darker.\r
 110  \r
 111     RESET Button:  Clicking this button will restore the selected\r
 112         color to the value it had when it was first selected.\r
 113  \r
 114     BLEND Button:  Clicking this button will let you Blend a range\r
 115         of colors together.  One end of the range of colors is the\r
 116         currently selected color.  After Clicking the BLEND button.\r
 117         You must click on the color at the other end of the range\r
 118         in the Palette Display Box.  All of the colors in between\r
 119         those two colors will be changed to represent a gradual\r
 120         transition from the color at one end to the color at the\r
 121         other end.\r
 122  \r
 123     PALETTE FILE NAME BOX:  This Text Box is used to enter the name\r
 124         of a Palette file to load or the name to save the current\r
 125         Palette as.  Just click on the Box, and it will change color\r
 126         and a flashing cursor will appear.  Now you type in a filename\r
 127         or edit the existing filename.  Press <RETURN> or click\r
 128         outside the text box to end editing.\r
 129  \r
 130     PALETTE DISPLAY BOX:  This Box shows all 256 colors in an array\r
 131         of 32 by 8 color blocks.  The Currently Selected Color will\r
 132         have a Box around it.  Clicking on a color with the Left\r
 133         Mouse button will make that color the new currently selected\r
 134         color.  Clicking on a color with the Right Mouse Button will\r
 135         copy the color value from the old selected color to it, before\r
 136         it is made the new selected color.\r
 137  \r
 138     Message Bar:  At the very bottom of the screen, this Bar will display\r
 139         information and messages for various functions.\r
 140  \r
 141 PALETTE FILE FORMAT:\r
 142  \r
 143      BINARY image, in order of VGA DAC (Color) Number.  3 Bytes Per\r
 144      Color, 256 Colors.  768 Bytes total.  The Files will be exactly\r
 145      768 bytes in size.\r
 146  \r
 147     COLOR:\r
 148         RED:    1 BYTE\r
 149         GREEN: 1 BYTE\r
 150         BLUE:   1 BYTE\r
 151  \r
 152     PALETTE:  Array (0 to 255) of COLOR\r
 153  \r
 154 COMMENTS, QUESTIONS, BUG REPORTS, etc:\r
 155  \r
 156     Send the to the Author:  Matt Pritchard\r
 157  \r
 158     Through the 80xxx Fidonet Echo or\r
 159  \r
 160     Matt Pritchard\r
 161     P.O. Box 140264\r
 162     Irving, TX  75014\r
 163  \r
 164 CREDITS:\r
 165  \r
 166     This Palette Editor was written in QuickBASIC 4.5\r