RenderWare(R) V1.4 d Release Notes ===================================== February 1995 ------------- ---------------------------------------------------------------------- This software is copyright Criterion Software Limited 1995. All Rights Reserved. This software is furnished under a license agreement or a non-disclosure agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the license or non-disclosure agreement. RenderWare is a registered trademark of Canon Inc. ---------------------------------------------------------------------- Introduction ---------------------------------------------------------------------- Welcome to RenderWare V1.4 (d) for MS Windows! These release note describe various aspects of Version 1.4 of RenderWare for the MS Windows family of Operation systems. ---------------------------------------------------------------------- Installation ---------------------------------------------------------------------- The files in the RenderWare v1.4 release for MS Windows are in compressed format. You must, therefore, use the supplied setup program to install RenderWare. To install RenderWare insert the CD into your CD-ROM drive. Select the "Run..." option from the "File" menu of the Program Manager. Enter D:\RWWIN\SETUP.EXE (assuming your CD-ROM drive is drive D:) and press the "OK" button or hit the "return" key. From then on simply follow the setup program's instructions. ---------------------------------------------------------------------- Configuration ---------------------------------------------------------------------- RenderWare V1.4 (d) applications running under MS Windows do not require a configuration file. However, RenderWare applications should be run under MS Windows with the environment variable "RWSHAPEPATH" appropriately set. "RWSHAPEPATH" should be set to a directory path comprising all directories that contain RenderWare script and texture files. For this distribution "RWSHAPEPATH" should be: set RWSHAPEPATH=C:\RWWIN\SCRIPTS;C:\RWWIN\TEXTURES (If RenderWare V1.4 (d) is not installed in "C:\RWWIN" please substitute the actual installation directory in the above command) Please note that this environment variable cannot be set from a DOS window when running MS Windows. It must be set at the DOS prompt before entering MS Windows. It is strongly recommended that the above line be added to the "AUTOEXEC.BAT" of any machine on which RenderWare is to run. This will ensure that the shape path is set whenever the machine starts. ---------------------------------------------------------------------- Release Content ---------------------------------------------------------------------- Once you have installed the RenderWare V1.4 Ms-Windows SDK, the following top level directories will be present. Each directory in the release contains a readme file that describes the content of the directory. (Note: The actual content of the directories will depend on the options that were selected at installation time. This list describes a full installation). Each of these directories contains a readme.txt file which describes the content in more detail. DEMO ---- A number of RenderWare demo programs in executable form. INCLUDE ------- This directory contains the main RenderWare header files. This directory should be on the include path when building a RenderWare application. LIB --- This directory contains the RenderWare library files. This directory should be on the link path when building a RenderWare application. SCRIPTS ------- This directory contains sample RenderWare scripts. TEXTURES -------- This directory contains sample RenderWare textures. DOC --- The RenderWare API manual as an on-line Windows .HLP file SRC --- The source for all of the RenderWare demonstration programs ---------------------------------------------------------------------- Documentation Errata ---------------------------------------------------------------------- B-11 The Watcom DLL binding libraries are incorrectly named as rwxw.lib and rwlw.lib. There should be four libraries named rwrxw.lib, rwrlw.lib, rwsxw.lib and rwslw.lib. See the readme in the \RWWIN\LIB directory for more detailed information B-33 RwDeviceControl(). The rwWINSETOUTPUTSIZE option is defined but no mention is made of how to turn off this facility once it has been enabled. Specifying a width and height of -1 will disable viewport stretching. RwWinOutputSize winOutputSize; winOutputSize.width = (RwInt32)-1; winOutputSize.height = (RwInt32)-1; winOutputSize.camera = Camera; RwDeviceControl(rwWINSETOUTPUTSIZE, 0, &winOutputSize, sizeof(winOutputSize); ---------------------------------------------------------------------- Known Problems ---------------------------------------------------------------------- We are aware of a small number of defects with this release of RenderWare. We aim to correct these defects in a future release. RenderWare V1.4 Defect List d-89 Non-even viewport widths may produce a 1 pixel wide strip of incorrect rendering on the right-hand size of the viewport. Specifying an even viewport width will resolve this problem. (Severity 3: non-fatal). d-107 Polygons which have a masked texture applied to them are still picked, even if the the pick position is over a masked (fully transparent) pixel. (Severity 3: non-fatal). d-123 The documentation of RwSplineTransforms() suggests that, by specifying an "UP" vector, banking will be suppressed. This is not the case. Specifying an "UP" vector will prevent the generation of matrices which "flip" vertical orientation but will not lock the the "UP" vector of the matrix. (Severity 4: non-fatal). d-135 "2D" container clumps in scenes can lead to incorrect rendering. If an object is "2D", for example, a flat plane, and is marked with the clump hint "rwCONTAINER", then incorrect object ordering can result. To correct the problem add "phantom" vertices to the clump to extend it into the third dimension. (Severity 3: non-fatal). d-172 If RwRenderClump() is passed a clump which is part of a hierarchy (i.e., a clump which has a parent and/or children) the library will crash. Passing individual clumps to RwRenderClump() avoids this problem. (Severity 2: fatal). d-204 When using the RenderWare Windows DLL it is not possible to terminate one of the RwForAll...() enumeration functions from within a callback function with RwSetUserError(). There is no way of stopping enumeration from within a callback when using the DLL. (Severity 3: non-fatal). d-236 Scaling a clump by a nagative value results in incorrect object lighting. If you wish to reverse and object such that its polygons face in rather than out, enumerate through the polygons in the clump with RwForAllPolygonsInClump() calling RwReversePolygonFace(). (Severity 3: non-fatal). d-237 Specifying the hint rwEDITABLE does not yield identical behaviour with the hint combination rwHS | rwEDITABLE. The semantics of hints state that rwEDITABLE and rwHS | rwEDITABLE are identical. However, in certain situations they are not and rwEDITABLE alone can yield incorrect results. Always specify rwHS | rwEDITABLE to avoid this problem. (Severity 3: non-fatal). d-249 If, during an API level RwModelBegin() and RwModelEnd() context in which prototypes have been defined, RwForAllClumpsInScene() (or one of its variants) is called with the default scene the clumps forming the prototype clumps defined in that modelling context will be passed to the callback function. To avoid this problem use a scene created with RwCreateScene() to hold the clumps of interest. (Severity 3: non-fatal). d-260 RwSetCameraBackColor() and RwSetCameraBackColorStruct() do not check the range of the color component values they are passed. If out of range values (less than CREAL(0.0) or greater than CREAL(1.0)) then the resulting colors are undefined. Ensure only color components in the range CREAL(0.0) and CREAL(1.0) are passed. (Severity 3: non-fatal). d-264 RwSetPaletteEntries() does not report an error if a NULL pointer is passed in the place of the RwPaletteEntry array. The function will simply take no action. (Severity 3: non-fatal). d-265 When using debugging versions of the RenderWare Windows DLL certain error conditions result in an error code being set but no message issued to the debug stream. (Severity 3: non-fatal) ---------------------------------------------------------------------- Acknowledgments ---------------------------------------------------------------------- RenderWare is a registered trademark of Canon Inc. Microsoft, MS, MS-DOS and Windows are registered trademarks of Microsoft Corporation. Pentium is a registered trademark of Intel Corporation.