home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / cd32 / cd32-tools / cdxl-1 / doc / cdgsxl.doc < prev    next >
Text File  |  1993-10-15  |  5KB  |  140 lines
  1. TABLE OF CONTENTS
  2.  
  3. cdgsxl
  4. cdgsxl                                                             cdgsxl
  5.  
  6.    NAME
  7.         cdgsxl - An AmigaCD CDXL player
  8.  
  9.    SYNOPSIS
  10.         cdgsxl FROM/A,X/K/N,Y/K/N,VOL/K/N,VIEW/S,BLIT/S,BACK/K,MULTIPAL/S,
  11.                 XLSPEED/K/N,NOXLEEC/S,XLPAL/S,LACE/S,NONLACE/S,HIRES/S,LORES/S,
  12.                 BOXIT/S,SDBL/S,NTSC/S,PAL/S,DEFMON/S,NOPOINTER/S,XLMODEID/S,
  13.                 ENDDELAY/K/N,LOOP/K/N,CDXL/S,DOSXL/S,NOPROMOTE/S,LMBABORT/S,
  14.                 RMBABORT/S,FIREABORT/S,MSGPORTNAME/K,HAM/S,NONHAM/S,EHB/S,
  15.                 NONEHB/S:
  16.  
  17.    FUNCTION
  18.         Play a CDXL file.
  19.  
  20.    INPUTS
  21.         FROM/A          - Required CDXL filename to play.
  22.  
  23.         X/K/N           - X position to display and play CDXL file.
  24.                           If not specified will center.
  25.  
  26.         Y/K/N           - Y position to display and play CDXL file.
  27.                           If not specified will center.
  28.  
  29.         VOL/K/N         - Volume to play CDXL audio at. Default is 64.
  30.  
  31.         VIEW/K/N        - Open a view to display the CDXL as opposed to
  32.                           a screen. Default is screen.
  33.  
  34.         BLIT/S          - Load the CDXL image into a seperate buffer
  35.                           that is then 'blitted' to the display. Otherwise
  36.                           load the image directly to the display. Default is
  37.                           'NON' BLIT.
  38.  
  39.         BACK/K          - An ILBM file to load into the background. Iffparse.library
  40.                           must be present. Implies BLIT mode.
  41.  
  42.         MULTIPAL/S      - Forces a new palette to be loaded for each frame.
  43.                           Default is NO MULTIPAL.
  44.  
  45.         XLSPEED/K/N     - Forces an override READXLSPEED. If specified speed is 
  46.                           greater than the max speed for your drive, the max speed
  47.                           is used.
  48.                                         
  49.         NOXLEEC/S       - Turns off error correction. Default is on.
  50.  
  51.  
  52.         XLPAL/S         - If using the BACK option to load an ILBM background,
  53.                           use the palette stored in the CDXL file as opposed to
  54.                           the ILBM's palette.
  55.  
  56.         LACE/S          - Force an interlace display. Will override CDXL or
  57.                           ILBM setting.
  58.  
  59.         NONLACE/S       - Force a non interlace display. Will override CDXL or
  60.                           ILBM setting.
  61.  
  62.         HIRES/S         - Force a HIRES display. Will override CDXL or
  63.                           ILBM setting.
  64.  
  65.         LORES/S         - Force a LORES display. Will override CDXL or
  66.                           ILBM setting.
  67.  
  68.         BOXIT/S         - Draw a box in color 0 around the CDXL image. May be
  69.                           necessary to avoid some HAMing problems.
  70.  
  71.         SDBL/S          - Open a Scan Doubled Display
  72.  
  73.         NTSC/S          - Use NTSC MonitorID
  74.  
  75.         PAL/S           - Use PAL MonitorID
  76.  
  77.         DEFMON/S        - Use DEFAULT MonitorID
  78.  
  79.         NOPOINTER/S     - Turn off Intuition Pointer
  80.  
  81.         XLMODEID/S      - Use the CDXL's idea of the ModeID (applies if
  82.                           the BACK option is used to override the back
  83.                           ILBM's ModeID).
  84.  
  85.         ENDDELAY/K/N    - How many VBlanks to delay when finished playing
  86.                           whole file before closing down the display.
  87.  
  88.         LOOP/K/N        - How many times to play the CDXL. A negative number
  89.                           means infinite loops.
  90.  
  91.         CDXL/S          - Play the CDXL off of the CD filesystem. (The default).
  92.  
  93.         DOSXL/S         - Play the CDXL off of the DOS filesystem.
  94.  
  95.         NOPROMOTE/S     - Do NOT Mode Promote the Display
  96.  
  97.         LMBABORT/S      - Left Mouse Button aborts playback
  98.  
  99.         RMBABORT/S      - Right Mouse Button aborts playback
  100.  
  101.         FIREABORT/S     - Joystick Fire Button aborts playback
  102.  
  103.         MSGPORTNAME/K   - Create a MsgPort with given name. This port
  104.                           can be used by another program to send commands
  105.                           to cdgsxl. See xlmsg.c.
  106.  
  107.         XLTAG_HAM       - Force HAM display. Will override CDXL or
  108.                           ILBM setting.
  109.  
  110.         XLTAG_NONHAM    - Force NON HAM display. Will override CDXL or
  111.                           ILBM setting.
  112.  
  113.         XLTAG_EHB       - Force EXTRA_HALFBRITE display. Will override CDXL or
  114.                           ILBM setting.
  115.  
  116.         XLTAG_NONEHB    - Force NON EXTRA_HALFBRITE display. Will override CDXL or
  117.                           ILBM setting.
  118.  
  119.         XLTAG_Patch_OpenWB - SetFunction OpenWorkbench() so that when the screen
  120.                              closes, if its the last screen in the system, it will
  121.                              not force the WorkBench screen to open.
  122.  
  123.  
  124.  
  125.    RESULTS
  126.         The specified CDXL file will be played per specifications.
  127.  
  128.  
  129.    NOTES
  130.  
  131.  
  132.    SEE ALSO
  133.         cdgsxl.c RunCDXL.c Display.c AudioCDXL.c
  134.         runcdxl.h cdxlob.h AsyncXL.c
  135.         RunCDXL.doc AudioCDXL.doc xlmsg.c xlm.h
  136.  
  137.    BUGS
  138.         None?
  139.  
  140.