home *** CD-ROM | disk | FTP | other *** search
/ Learn 3D Graphics Programming on the PC / Learn_3D_Graphics_Programming_on_the_PC_Ferraro.iso / rwwin / readme.txt < prev    next >
Text File  |  1995-11-14  |  10KB  |  222 lines
  1.               RenderWare(R) 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 (d) for MS Windows!
  24.  
  25. These release note describe various aspects of Version 1.4 of
  26. RenderWare for the MS Windows family of Operation systems.
  27.  
  28. ----------------------------------------------------------------------
  29.                          Installation
  30. ----------------------------------------------------------------------
  31.  
  32. The files in the RenderWare v1.4 release for MS Windows are 
  33. in compressed format. You must, therefore, use the supplied setup
  34. program to install RenderWare.
  35.  
  36. To install RenderWare insert the CD into your CD-ROM drive. Select
  37. the "Run..." option from the "File" menu of the Program Manager. Enter
  38.  
  39.     D:\RWWIN\SETUP.EXE
  40.  
  41. (assuming your CD-ROM drive is drive D:) and press the "OK" button or
  42. hit the "return" key. From then on simply follow the setup program's
  43. instructions.
  44.  
  45. ----------------------------------------------------------------------
  46.                           Configuration
  47. ----------------------------------------------------------------------
  48.  
  49. RenderWare V1.4 (d) applications running under MS Windows do not
  50. require a configuration file. However, RenderWare applications should
  51. be run under MS Windows with the environment variable "RWSHAPEPATH"
  52. appropriately set. "RWSHAPEPATH" should be set to a directory path
  53. comprising all directories that contain RenderWare script and texture
  54. files.  For this distribution "RWSHAPEPATH" should be:
  55.  
  56.     set RWSHAPEPATH=C:\RWWIN\SCRIPTS;C:\RWWIN\TEXTURES
  57.  
  58. (If RenderWare V1.4 (d) is not installed in "C:\RWWIN" please
  59. substitute the actual installation directory in the above command)
  60.  
  61. Please note that this environment variable cannot be set from a DOS
  62. window when running MS Windows. It must be set at the DOS prompt
  63. before entering MS Windows. It is strongly recommended that the above
  64. line be added to the "AUTOEXEC.BAT" of any machine on which RenderWare
  65. is to run. This will ensure that the shape path is set whenever the
  66. machine starts.
  67.  
  68. ----------------------------------------------------------------------
  69.                          Release Content
  70. ----------------------------------------------------------------------
  71.  
  72. Once you have installed the RenderWare V1.4 Ms-Windows SDK, the
  73. following top level directories will be present. Each directory in the
  74. release contains a readme file that describes the content of the
  75. directory. (Note: The actual content of the directories will depend on
  76. the options that were selected at installation time. This list
  77. describes a full installation). Each of these directories contains a
  78. readme.txt file which describes the content in more detail.
  79.  
  80. DEMO
  81. ----
  82. A number of RenderWare demo programs in executable form.
  83.  
  84. INCLUDE
  85. -------
  86. This directory contains the main RenderWare header files. This
  87. directory should be on the include path when building a RenderWare
  88. application.
  89.  
  90. LIB    
  91. ---
  92. This directory contains the RenderWare library files. This directory
  93. should be on the link path when building a RenderWare application.
  94.  
  95. SCRIPTS
  96. -------
  97. This directory contains sample RenderWare scripts.
  98.  
  99. TEXTURES
  100. --------
  101. This directory contains sample RenderWare textures.
  102.  
  103. DOC
  104. ---
  105. The RenderWare API manual as an on-line Windows .HLP file
  106.  
  107. SRC
  108. ---
  109. The source for all of the RenderWare demonstration programs
  110.  
  111. ----------------------------------------------------------------------
  112.                         Documentation Errata
  113. ----------------------------------------------------------------------
  114.  
  115. B-11    The Watcom DLL binding libraries are incorrectly named as
  116.         rwxw.lib and rwlw.lib. There should be four libraries named
  117.         rwrxw.lib, rwrlw.lib, rwsxw.lib and rwslw.lib. See the readme
  118.         in the \RWWIN\LIB directory for more detailed information
  119.  
  120. B-33    RwDeviceControl(). The rwWINSETOUTPUTSIZE option is defined
  121.         but no mention is made of how to turn off this facility once
  122.         it has been enabled. Specifying a width and height of -1 will 
  123.         disable viewport stretching.
  124.  
  125.         RwWinOutputSize winOutputSize;
  126.  
  127.         winOutputSize.width = (RwInt32)-1;
  128.         winOutputSize.height = (RwInt32)-1;
  129.         winOutputSize.camera = Camera;
  130.         RwDeviceControl(rwWINSETOUTPUTSIZE, 0, &winOutputSize, 
  131.                         sizeof(winOutputSize);
  132.  
  133.  
  134. ----------------------------------------------------------------------
  135.                            Known Problems
  136. ----------------------------------------------------------------------
  137.  
  138. We are aware of a small number of defects with this release of
  139. RenderWare. We aim to correct these defects in a future release.
  140.  
  141. RenderWare V1.4 Defect List
  142.  
  143. d-89  Non-even viewport widths may produce a 1 pixel wide strip of
  144.       incorrect rendering on the right-hand size of the viewport.
  145.       Specifying an even viewport width will resolve this problem.
  146.       (Severity 3: non-fatal).
  147.  
  148. d-107 Polygons which have a masked texture applied to them are still
  149.       picked, even if the the pick position is over a masked
  150.       (fully transparent) pixel. (Severity 3: non-fatal).
  151.  
  152. d-123 The documentation of RwSplineTransforms() suggests that,
  153.       by specifying an "UP" vector, banking will be suppressed. This
  154.       is not the case. Specifying an "UP" vector will prevent the
  155.       generation of matrices which "flip" vertical orientation but
  156.       will not lock the the "UP" vector of the matrix. (Severity 4:
  157.       non-fatal).
  158.  
  159. d-135 "2D" container clumps in scenes can lead to incorrect rendering.
  160.       If an object is "2D", for example, a flat plane, and is marked
  161.       with the clump hint "rwCONTAINER", then incorrect object ordering
  162.       can result. To correct the problem add "phantom" vertices to the
  163.       clump to extend it into the third dimension. (Severity 3:
  164.       non-fatal).
  165.  
  166. d-172 If RwRenderClump() is passed a clump which is part of a
  167.       hierarchy (i.e., a clump which has a parent and/or children) the
  168.       library will crash. Passing individual clumps to RwRenderClump()
  169.       avoids this problem. (Severity 2: fatal).
  170.  
  171. d-204 When using the RenderWare Windows DLL it is not possible to
  172.       terminate one of the RwForAll...() enumeration functions
  173.       from within a callback function with RwSetUserError(). There
  174.       is no way of stopping enumeration from within a callback
  175.       when using the DLL. (Severity 3: non-fatal).
  176.  
  177. d-236 Scaling a clump by a nagative value results in incorrect
  178.       object lighting. If you wish to reverse and object such that
  179.       its polygons face in rather than out, enumerate through the
  180.       polygons in the clump with RwForAllPolygonsInClump() calling
  181.       RwReversePolygonFace(). (Severity 3: non-fatal).
  182.  
  183. d-237 Specifying the hint rwEDITABLE does not yield identical behaviour
  184.       with the hint combination rwHS | rwEDITABLE. The semantics of
  185.       hints state that rwEDITABLE and rwHS | rwEDITABLE are identical.
  186.       However, in certain situations they are not and rwEDITABLE alone
  187.       can yield incorrect results. Always specify rwHS | rwEDITABLE to
  188.       avoid this problem. (Severity 3: non-fatal).
  189.  
  190. d-249 If, during an API level RwModelBegin() and RwModelEnd() context
  191.       in which prototypes have been defined, RwForAllClumpsInScene()
  192.       (or one of its variants) is called with the default scene the
  193.       clumps forming the prototype clumps defined in that modelling
  194.       context will be passed to the callback function. To avoid this
  195.       problem use a scene created with RwCreateScene() to hold the
  196.       clumps of interest. (Severity 3: non-fatal).
  197.  
  198. d-260 RwSetCameraBackColor() and RwSetCameraBackColorStruct() do not
  199.       check the range of the color component values they are passed.
  200.       If out of range values (less than CREAL(0.0) or greater than
  201.       CREAL(1.0)) then the resulting colors are undefined. Ensure
  202.       only color components in the range CREAL(0.0) and CREAL(1.0)
  203.       are passed. (Severity 3: non-fatal).
  204.  
  205. d-264 RwSetPaletteEntries() does not report an error if a NULL pointer
  206.       is passed in the place of the RwPaletteEntry array. The
  207.       function will simply take no action. (Severity 3: non-fatal).
  208.  
  209. d-265 When using debugging versions of the RenderWare Windows DLL
  210.       certain error conditions result in an error code being set but
  211.       no message issued to the debug stream. (Severity 3: non-fatal)
  212.  
  213. ----------------------------------------------------------------------
  214.                          Acknowledgments
  215. ----------------------------------------------------------------------
  216.  
  217. RenderWare is a registered trademark of Canon Inc.
  218. Microsoft, MS, MS-DOS and Windows are registered trademarks of
  219. Microsoft Corporation.
  220. Pentium is a registered trademark of Intel Corporation.
  221.  
  222.