home *** CD-ROM | disk | FTP | other *** search
/ Learn 3D Graphics Programming on the PC / Learn_3D_Graphics_Programming_on_the_PC_Ferraro.iso / rwdos / read1.txt < prev    next >
Encoding:
Text File  |  1995-02-15  |  4.3 KB  |  106 lines
  1.                     RenderWare(tm) v1.4 FCS Libraries
  2.                     =================================
  3.  
  4. ----------------------------------------------------------------------------
  5. These libraries are copyright Criterion Software Limited 1995. All Rights
  6. Reserved. You may not disassemble, decompile or reverse engineer these
  7. libraries.
  8.  
  9. These libraries are furnished under a license agreement or a non-disclosure
  10. agreement. The software may be used or copied only in accordance with the
  11. terms of the agreement. It is against the law to copy the software on any
  12. medium except as specifically allowed in the license or non-disclosure
  13. agreement.
  14.  
  15. RenderWare is a trademark of Canon Inc.
  16. ----------------------------------------------------------------------------
  17.  
  18. This directory contains the libraries of the RenderWare(tm) v1.4 release
  19. for MS-Dos.
  20.  
  21. Library Naming
  22. --------------
  23.  
  24. The names of the libraries located in this directory are derived using
  25. the following naming scheme:
  26.  
  27.     RW<platform><calling convention><numeric type><kernel type>.LIB
  28.  
  29. Where:
  30.     <platform>           is 'W' for Microsoft Windows 3.1 libraries and
  31.                             'D' for DOS libraries.
  32.  
  33.     <calling convention> is 'R' for the register based argument passing and
  34.                             'S' for stack based argument passing.
  35.  
  36.     <numeric type>       is 'X' for fixed-point libraries and
  37.                             'L' for floating-point libraries.
  38.  
  39.     <kernel type>        is 'P' for production libraries and
  40.                             'D' for debugging libraries.
  41.  
  42. For example,
  43.  
  44.     RWWRXP.LIB is the MS Windows 3.1, register based calling convention,
  45.                fixed-point, production version of the library.
  46.  
  47. and,
  48.  
  49.     RWDSLD.LIB is the DOS, stack based calling convention, floating-point,
  50.                debugging version of the library.
  51.  
  52. All the libraries have identical APIs and, therefore, share the same include
  53. files (found in the \rw\include\ directory of this distribution).
  54.  
  55. Platform
  56. --------
  57.  
  58. Simply link against the version of the library for the platform you wish to
  59. build for.
  60.  
  61. Calling Convention
  62. ------------------
  63.  
  64. Simply link against the library whose calling convention matches the one
  65. used by your application.
  66.  
  67. Numeric Type
  68. ------------
  69.  
  70. See the main readme for this distribution (\rw\readme.txt) and Chapter 2 of
  71. the RenderWare reference manual for a discussion of the fixed and floating-
  72. point versions of RenderWare. Having decided whether to use fixed or floating-
  73. point RenderWare (and having modified your application if necessary) simply
  74. link against the appropriate library.
  75.  
  76. Kernel Type
  77. -----------
  78.  
  79. Two versions of the RenderWare library kernel are available to developers. The
  80. production and debugging versions. The debugging version contains considerably
  81. more parameter validation and error checking than the production version. The
  82. debugging version also issues messages about errors and potential problems to
  83. a debugging stream. The debugging libraries are particularly useful in
  84. identifying missed API level error conditions, tracing the parsing of problem
  85. scripts, and when requesting technical support from the RenderWare technical
  86. support group.
  87.  
  88. This additional error checking and validation causes the debugging library to
  89. be considerably larger and slower than its production equivalent. Therefore,
  90. is is essential that the production kernel be used in all production builds.
  91. The debugging kernel must only be used during the application development process.
  92.  
  93. It is important to note, however, that the debugging kernel is designed to
  94. behave externally in exactly the same way as the production kernel. The flow
  95. of control is the same in both libraries. The debugging kernel will not attempt
  96. to abort an operation if its additional error checking detects an error. Instead,
  97. it attempts to issue informational messages which will assist the developer and
  98. RenderWare technical support to identify the problem.
  99.  
  100. To use the RenderWare debugging kernel simply relink your application against
  101. the appropriate debugging library. No recompilation is necessary. For
  102. more information on the debugging kernel see Chapter 1 of the RenderWare
  103. reference manual.
  104.  
  105.                     =================================
  106.