--- /dev/null
+byHeart Software\r
+620 Ballantree Road\r
+West Vancouver, B.C.\r
+Canada V7S 1W3\r
+\r
+Tel. (604) 922-6148\r
+Fax. (604) 987-7621\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ PCX_LIB Documentation\r
+ ---------------------\r
+ Version 1.00B\r
+\r
+\r
+ by Ian Ashdown, P.Eng.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ Released into the Public Domain 91/04/01\r
+\f\r
+1. Introduction\r
+\r
+ PCX_LIB is a library of functions for displaying and storing ZSoft's \r
+ Paintbrush (R) PCX-format image files. It was developed expressly \r
+ for release into the Public Domain. Fully commented ANSI C source \r
+ code is provided for all functions, along with complete technical \r
+ specifications for ZSoft's PCX image file format.\r
+\r
+ Version 1.00B supports the display and storage of images on MS-DOS \r
+ systems equipped with the following display adapters:\r
+\r
+ Hercules - monochrome\r
+ CGA - Color Graphics Adapter\r
+ EGA - Enhanced Graphics Adapter\r
+ MCGA - MultiColor Graphics Adapter\r
+ VGA - Video Graphics Adapter\r
+\r
+ All valid MS-DOS graphic modes are supported.\r
+\r
+ SuperVGA and XGA display adapters are not supported in this release.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ p. 1\r
+\f\r
+2. DISCLAIMER:\r
+\r
+ IN NO EVENT SHALL BYHEART SOFTWARE BE LIABLE FOR ANY DAMAGES \r
+ WHATSOEVER INCLUDING, WITHOUT LIMITATION, PERSONAL DAMAGES, DAMAGES \r
+ FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS \r
+ INFORMATION, OR OTHER PECUNIARY LOSS, ARISING OUT OF THE USE OR \r
+ INABILITY TO USE THIS PRODUCT, EVEN IF BYHEART SOFTWARE HAS BEEN \r
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ p. 2\r
+\f\r
+3. Disk Contents\r
+\r
+ The disk includes the following files:\r
+\r
+\r
+3.1. Documentation\r
+\r
+ PCX_LIB.DOC - PCX_LIB documentation (this file)\r
+ PCX_FMT.DOC - PCX image file format specifications\r
+\r
+\r
+3.2. ANSI C Source Code\r
+\r
+ PCX_COMM.C - PCX image file common functions\r
+ PCX_DISP.C - PCX image file display functions\r
+ PCX_EXAM.C - PCX image file header examination utility\r
+ PCX_FILE.C - PCX image capture functions\r
+ RD_DEMO.C - PCX image file display demonstration program\r
+ WR_DEMO.C - PCX image file capture demonstration program\r
+\r
+ PCX_EXT.H - PCX_LIB external definitions include file\r
+ PCX_INT.H - PCX_LIB internal definitions include file\r
+\r
+\r
+3.3. MS-DOS Executables\r
+\r
+ PCX_EXAM.EXE - PCX image file header examination utility\r
+ RD_DEMO.EXE - PCX image file display demonstration program\r
+ WR_DEMO.EXE - PCX image file capture demonstration program\r
+\r
+\r
+3.4. Sample PCX Image Files\r
+\r
+ TEST_04.PCX - 320 x 200 4-color CGA test image (mode 4)\r
+ TEST_06.PCX - 640 x 200 2-color CGA test image (mode 6)\r
+ TEST_16.PCX - 640 x 350 16-color EGA test image (mode 16)\r
+ TEST_19.PCX - 320 x 200 256-color VGA test image (mode 19)\r
+\r
+\r
+3.5. Miscellaneous\r
+\r
+ PCX_LIB.BAT - Microsoft C V6.0 program build batch file\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ p. 3\r
+\f\r
+4. Trying It Out\r
+\r
+ Four test images are included on the disk, one each for MS-DOS video \r
+ modes 4, 6, 16 and 19. \r
+\r
+\r
+4.1. PCX_EXAM\r
+\r
+ PCX_EXAM reads a PCX-format image file and displays a summary of \r
+ the information contained in the file header. A full explanation\r
+ of this information is presented in PCX_FMT.DOC.\r
+\r
+ To run PCX_EXAM with a file (e.g. - "MY_PICT.PCX"), enter:\r
+\r
+ PCX_EXAM my_pict.pcx\r
+\r
+\r
+4.2. RD_DEMO\r
+\r
+ To display any of these images, enter:\r
+\r
+ RD_DEMO test_xx.pcx xx\r
+\r
+ where "xx" is the video mode (e.g. - "RD_DEMO test_06.pcx 6"). \r
+ Your display adapter must be capable of emulating the specified \r
+ video mode in order to display the image.\r
+\r
+ Once the image is displayed, press any key to clear the screen and \r
+ return to DOS.\r
+\r
+ RD_DEMO will also display a PCX-format image if your display \r
+ adapter supports its appropriate video mode. For example, to \r
+ display a PCX-format image file "MY_PICT.PCX" that was created for \r
+ display on 320 x 200 256-color VGA displays, enter: \r
+\r
+ RD_DEMO my_pict.pcx 19\r
+\r
+\r
+4.3. WR_DEMO\r
+\r
+ The demonstration program WR_DEMO will first display a PCX-format \r
+ image file, then capture the image directly from the display \r
+ adapter's memory and create a PCX-format image file called \r
+ "PCX_DEMO.PCX".\r
+\r
+ To run WR_DEMO, enter:\r
+\r
+ WR_DEMO test_xx.pcx xx\r
+ \r
+ where "xx" is the video mode (e.g. - "WR_DEMO test_06.pcx 6"). \r
+ Your display adapter must be capable of emulating the specified \r
+ video mode in order to display and capture the image.\r
+\r
+\r
+ p. 4\r
+\f\r
+ Once the image is displayed, WR_DEMO will automatically capture \r
+ it and create the file "PCX_DEMO.PCX" before clearing the screen \r
+ and returning to DOS.\r
+\r
+ WR_DEMO will also display and capture a PCX-format image if your\r
+ display adapter supports its appropriate video mode. For example, \r
+ to capture a PCX-format image file "MY_PICT.PCX" that was created \r
+ for display on 320 x 200 256-color VGA displays, enter: \r
+\r
+ WR_DEMO my_pict.pcx 19\r
+\r
+ WR_DEMO captures the entire screen and all color planes, so the\r
+ size of the resultant PCX_DEMO.PCX file may be different than the\r
+ file it displayed.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ p. 5\r
+\f\r
+5. Using The Library\r
+\r
+ The public functions in PCX_LIB (i.e. - those meant to be called by \r
+ application programs) are:\r
+\r
+ pcx_read - display a PCX-format image file\r
+ pcx_write - capture a displayed image to a PCX-format file\r
+\r
+ pcx_isvga - determine whether a display adapter supports\r
+ VGA BIOS calls\r
+\r
+ pcx_init_dsa - set up BIOS to capture EGA color palette\r
+ register updates\r
+ pcx_free_dsa - reset BIOS to state before call to \r
+ "pcx_inst_dsa"\r
+\r
+ All functions are fully and exhaustively documented in the source \r
+ code files. Example calls to the public functions may be found in \r
+ the source code files RD_DEMO.C and WR_DEMO.C.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+ p. 6\r
+\r