README.md

   1 # NVIDIA PhysX SDK 3.4
   2
   3 Copyright (c) 2018 NVIDIA Corporation. All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions
   7 are met:
   8  * Redistributions of source code must retain the above copyright
   9    notice, this list of conditions and the following disclaimer.
  10  * Redistributions in binary form must reproduce the above copyright
  11    notice, this list of conditions and the following disclaimer in the
  12    documentation and/or other materials provided with the distribution.
  13  * Neither the name of NVIDIA CORPORATION nor the names of its
  14    contributors may be used to endorse or promote products derived
  15    from this software without specific prior written permission.
  16
  17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
  18 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20 PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  21 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  25 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 ## Introduction
  30
  31 Welcome to NVIDIA's PhysX and APEX SDK source code repository. This depot includes the PhysX SDK, the APEX SDK, and the Kapla Demo application.
  32
  33 NOTE: The APEX SDK is not needed to build either the PhysX SDK nor the demo and has been deprecated. It is provided for continued support of existing applications only. We recommend the following libraries as replacements:
  34
  35 For APEX Clothing: NvCloth - https://github.com/NVIDIAGameWorks/NvCloth
  36
  37 For APEX Destruction: Blast - https://github.com/NVIDIAGameWorks/Blast
  38
  39 For APEX Particles: Flex - https://github.com/NVIDIAGameWorks/FleX
  40
  41 For APEX Turbulence: Flow - https://github.com/NVIDIAGameWorks/Flow
  42
  43 ## Documentation
  44
  45 Online Documentation:
  46
  47 http://gameworksdocs.nvidia.com/simulation.html
  48
  49 The documentation can also be found in the repository under
  50 * \PhysX_3.4\Documentation
  51 * \APEX_1.4\docs
  52
  53 Please also see the following readme files:
  54 * \PhysX_3.4\readme_*.html,
  55 * \APEX_1.4\readme.txt.
  56
  57 ## Instructions
  58
  59 To begin, clone this repository onto your local drive.
  60
  61 To build PhysX and APEX SDKs:
  62
  63 (1) Build PhysX SDK by opening one of the solutions found under PhysX_3.4\Source\compiler.
  64 Supported platforms: Windows, Linux, OSX, Android, iOS.
  65
  66 (2) The APEX SDK distribution contains pre-built binaries supporting GPU acceleration.
  67 Re-building the APEX SDK removes support for GPU acceleration. The solutions can be found under APEX_1.4\compiler.
  68 Supported platforms: Windows, Linux, Android.
  69 ______________________________________________________________
  70 To build PhysX Snippets: open one of the solutions found under \PhysX_3.4\Snippets\compiler.
  71
  72 To build PhysX Samples (windows only): open one of the solutions found under \PhysX_3.4\Samples\compiler.
  73
  74 To build APEX Snippets: open one of the solutions found under \APEX_1.4\snippets\compiler.
  75
  76 To build APEX Samples: open one of the solutions found under \APEX_1.4\samples_v2\compiler.
  77
  78 To build and run the Kapla Demo (KaplaDemo\samples\compiler) please make sure to build the PhysX SDK with the same Visual Studio version and with the same build configuration **before** compiling the Kapla Demo. This will make sure the appropriate DLLs are copied to the KaplaDemo bin directory.
  79
  80 ## Acknowledgements
  81
  82 This depot contains external third party open source software copyright their respective owners:
  83
  84 Alexander Chemeris,
  85 The Android Open Source Project,
  86 Brian Paul,
  87 Brodie Thiesfield,
  88 Electronic Arts,
  89 Emil Mikulic,
  90 FreeImage,
  91 Hewlett-Packard Company,
  92 Independent JPEG Group,
  93 John W. Ratcliff,
  94 Julio Jerez,
  95 Kevin Bray,
  96 The Khronos Group Inc.,
  97 Kitware, Inc.,
  98 Mark J. Kilgard,
  99 Microsoft Corporation,
 100 Open Dynamics Framework Group,
 101 Python Software Foundation,
 102 Univ. of Western Ontario,
 103 and the ASSIMP, clang and glew development teams.