home *** CD-ROM | disk | FTP | other *** search
/ Learn 3D Graphics Programming on the PC / Learn_3D_Graphics_Programming_on_the_PC_Ferraro.iso / rwdos / readme.txt < prev    next >
Text File  |  1995-11-16  |  11KB  |  254 lines
  1.               RenderWare(TM) v1.4 d Release Notes
  2.               =====================================
  3.  
  4.                         February 1995
  5.                         -------------
  6.  
  7. ----------------------------------------------------------------------
  8. This software is copyright Criterion Software Limited 1995. All Rights
  9. Reserved.
  10.  
  11. This software is furnished under a license agreement or a
  12. non-disclosure agreement. The software may be used or copied only in
  13. accordance with the terms of the agreement. It is against the law to
  14. copy the software on any medium except as specifically allowed in the
  15. license or non-disclosure agreement.
  16.  
  17. RenderWare is a registered trademark of Canon Inc.
  18.  
  19. ----------------------------------------------------------------------
  20.                            Introduction
  21. ----------------------------------------------------------------------
  22.  
  23. Welcome to RenderWare v1.4!
  24.  
  25. These release note describe various aspects of Version 1.4 of
  26. RenderWare for MS Dos. Information on the new features that have
  27. been added for V1.4 and the features that have changed, can be 
  28. found in the printed documentation supplied with the SDK
  29.  
  30. ----------------------------------------------------------------------
  31.                          Installation
  32. ----------------------------------------------------------------------
  33.  
  34. To install RenderWare 1.4 for DOS you should use the supplied installation
  35. program. To initiate an installation make the current working directory the
  36. directory that you are installing from. So if your CD drive is drive E type
  37.  
  38. E: <RETURN>
  39.  
  40. change to the RenderWare Dos installation directory \rwdos
  41.  
  42. CD RWDOS <RETURN>
  43.  
  44. To start the installation type
  45.  
  46. INSTALL <RETURN>
  47.  
  48. The installation program will give you options on what you wish to install.
  49.  
  50. ----------------------------------------------------------------------
  51.                        Environment Variables
  52. ----------------------------------------------------------------------
  53.  
  54. The environment variable RWSHAPEPATH must be set to a directory path
  55. comprising all directories that contain RenderWare script and
  56. texture files. The installation program will take care of this for you
  57. but if you subsequently move the RenderWare installatio then you will 
  58. need to modify these values.
  59.  
  60. For this distribution RWSHAPEPATH should be set to:
  61.  
  62. set RWSHAPEPATH=c:\rwdos\scripts;c:\rwdos\textures;
  63.  
  64. If RenderWare is not installed in "c:\rwdos\" please substitute the
  65. actual location in the above command.
  66.  
  67. Also of importance is the environment variable RWHOME. This defines the
  68. directory where RenderWare looks for the dosrw.ini file which defines
  69. characteristics such as screen resolution. To use the default dosrw.ini file
  70. which is located in the root directory of the distribution RWHOME should
  71. be set to:
  72.  
  73. set RWHOME=c:\rwdos
  74.  
  75. Note that if you wish to try a different resolution on a demonstration program
  76. just edit the rwdos.ini file to obtain the mode you require. Check that your
  77. machine has a VESA BIOS and is capable to achieving the resolution (use
  78. VESAMODE to check and UNIVBE for a VESA BIOS TSR).
  79.  
  80.  
  81. It is strongly recommended that the above lines are added to the AUTOEXEC.BAT
  82. of any machine on which RenderWare is to run. This will ensure that the shape
  83. path is set whenever the machine starts, and the same screen configuration
  84. is picked up.
  85.  
  86.  
  87. ----------------------------------------------------------------------
  88.                              Configuration
  89. ----------------------------------------------------------------------
  90.  
  91. RenderWare v1.4 applications running under MS DOS do not
  92. require a configuration file. However, RenderWare applications should
  93. be run under MS DOS with the environment variable RWSHAPEPATH
  94. appropriately set - see "Environment Variables" above.
  95.  
  96. ----------------------------------------------------------------------
  97.                          Release Content
  98. ----------------------------------------------------------------------
  99.  
  100. Once you have installed the RenderWare V1.4 DOS SDK, the following
  101. top level directories will be present. Each directory in the release
  102. contains a readme file that describes the content of the directory.
  103.  
  104. DEMO
  105. ----
  106. This directory is split into 2 subdirectories, RWGIFTS and SAMPLE. 
  107. Both of these subdirectories contain RenderWare demonstration programs 
  108. together with source code. The difference between the 2 is that the 
  109. SAMPLE directory contains programs that have been written for the 
  110. RenderWare V1.4 API, whereas the RWGIFTS directory contains demo source
  111. that was written for a previous release of RenderWare and has simply
  112. been ported to V1.4 without taking advantage of any of the new features.
  113.  
  114. the SAMPLE sources are as follows
  115.  
  116.     DOSCYBER - Cyberstreet
  117.     DOSROLLE - Rollercoaster
  118.     DOSVIEW  - A simple viewer
  119.  
  120. the RWGIFTS sources are as follows
  121.  
  122.     DOSEXP   - Duck Shoot
  123.     DOSKNIGH - Animated Knights
  124.     DOSMAZE  - Maze walkthrough
  125.     DOSROBOT - Robbie the Robot
  126.     DOSSIM   - N Body Simulation
  127.     DOSTANK  - Tank simualation
  128.     DOSTUNNE - Tunnel
  129.  
  130. Each of these programs has a SRC, a SCRIPTS and a TEXTURES directory.
  131. Note: The executable for each of these demos requires that the scripts
  132. and textures are either in the same directory as the executable or are
  133. contained in subdirectories called SCRIPTS and TEXTURES respectively.
  134. If any of the demo sources are built in place, then the executable will
  135. need to be moved into the parent directory in order for the program to
  136. run. Alternatively you can copy the SCRIPTS and TEXTURES directory into
  137. the SRC directory.
  138.  
  139. INCLUDE
  140. -------
  141. This directory contains the main RenderWare header files. This
  142. directory should be on the include path for all applications that use
  143. RenderWare.
  144.  
  145. LIB    
  146. ---
  147. This directory contains the RenderWare library files. This directory
  148. should be on the link path for all applications that use RenderWare.
  149.  
  150. SCRIPTS
  151. -------
  152. This directory contains sample RenderWare scripts. There are 3 
  153. subdirectories that contain additional scripts.
  154.  
  155.     EXTRA   - Public domain 3D models that have been converted into the
  156.               RenderWare format. 
  157.     TEXT    - Simple polygonal font scripts
  158.     EXTTEXT - Extruded versions of the TEXT directory
  159.  
  160. TEXTURES
  161. --------
  162. This directory contains sample RenderWare textures. There is an
  163. single subdirectories that contains additional scripts.
  164.  
  165.     EXTRA   - Public domain 3D textures that have been converted into a 
  166.               format readable by RenderWare.
  167.  
  168. TOOLS   
  169. -----
  170. The following 2 tools are provided for use with RenderWare for DOS.
  171.  
  172.     UNIVBE - So that many different video cards can be used with
  173.              RenderWare, for resolutions higher than 320x200, RenderWare
  174.              conforms to the VESA standard. If your card has a VESA bios
  175.              then RenderWare will function at other resolutions. If you
  176.              have an older card then you will need to install a VESA
  177.              bios TSR (terminate and stay resident) program. UNIVBE is a
  178.              VESA TSR and works with most SuperVGA cards. Read the
  179.              UNIVBE documentation to check if UNIVBE is compatible with
  180.              your card.
  181.  
  182.              The file "vesatest.txt" gives details of cards that
  183.              RenderWare for DOS has been tested on. It also shows if a
  184.              tested card works with UNIVBE correctly when using
  185.              RenderWare for DOS.
  186.  
  187.     VESAMODE - This is a simple program, which first checks if you have
  188.              a VESA bios available. If so it will list all of the modes
  189.              that are available for access. Only standard VESA modes may
  190.              be accessed by RenderWare. Read the documentation in the
  191.              "tools\vesamode" directory for more details.
  192.  
  193. ----------------------------------------------------------------------
  194.                            Known Problems
  195. ----------------------------------------------------------------------
  196.  
  197. We are aware of a very small number of minor problems with this
  198. release of RenderWare. These problems will be corrected in the next
  199. RenderWare v1.x maintenance release.
  200.  
  201. RenderWare V1.4 Defect List
  202.  
  203. d-107 Polygons which have a masked texture applied to them are still
  204.       picked, even if the the pick position is over a masked
  205.       (fully transparent) pixel. (Severity 3: non-fatal).
  206.  
  207. d-123 The documentation of RwSplineTransforms() suggests that,
  208.       by specifying an "UP" vector, banking will be suppressed. This
  209.       is not the case. Specifying an "UP" vector will prevent the
  210.       generation of matrices which "flip" vertical orientation but
  211.       will not lock the the "UP" vector of the matrix. (Severity 4:
  212.       non-fatal).
  213.  
  214. d-135 "2d" container clumps in scenes can lead to incorrect rendering.
  215.       If an object is "2D", for example, a flat plane, and is marked
  216.       with the clump hint "rwCONTAINER", then incorrect object ordering
  217.       can result. To correct the problem add "phantom" vertices to the
  218.       clump to extend it into the third dimension. (Severity 3:
  219.       non-fatal).
  220.  
  221. d-172 If RwRenderClump() is passed a clump which is part of a
  222.       hierarchy (i.e., a clump which has a parent and/or children) the
  223.       library will crash. Passing individual clumps to RwRenderClump()
  224.       avoids this problem. (Severity 2: fatal).
  225.  
  226. d-249 If during an API level RwModelBegin() and RwModelEnd() context
  227.       in which prototypes have been defined RwForAllClumpsInScene()
  228.       (or one of its variants) is called with the default scene the
  229.       clumps forming the prototype clumps defined in that modelling
  230.       context will be passed to the callback function. To avoid this
  231.       problem use a scene created with RwCreateScene() to hold the
  232.       clumps of interest. (Severity 3: non-fatal).
  233.  
  234. d-260 RwSetCameraBackColor() and RwSetCameraBackColorStruct() do not
  235.       check the range of the color component values they are passed.
  236.       If out of range values (less than CREAL(0.0) or greater than
  237.       CREAL(1.0)) then the resulting colors are undefined. Ensure
  238.       only color components in the range CREAL(0.0) and CREAL(1.0)
  239.       are passed. (Severity 3: non-fatal).
  240.  
  241. d-264 RwSetPaletteEntries() does not report an error if a NULL pointer
  242.       is passed in the place of the RwPaletteEntry array. The
  243.       function will simply take no action. (Severity 3: non-fatal).
  244.  
  245. ----------------------------------------------------------------------
  246.                          Acknowledgments
  247. ----------------------------------------------------------------------
  248.  
  249. RenderWare is a registered trademark of Canon Inc.
  250. Microsoft, MS, MS-DOS and Windows are registered trademarks of
  251. Microsoft Corporation.
  252. Pentium is a registered trademark of Intel Corporation.
  253.  
  254.