diff options
Diffstat (limited to 'README.md')
| -rwxr-xr-x[-rw-r--r--] | README.md | 258 |
1 files changed, 130 insertions, 128 deletions
diff --git a/README.md b/README.md index 7569cd5..e03e795 100644..100755 --- a/README.md +++ b/README.md @@ -1,128 +1,130 @@ -Blast 1.1.2 -=========== - - - -Introduction ------------- - -Blast is a new NVIDIA GameWorks destruction library. It consists of three layers: the low-level (NvBlast), a high-level "toolkit" -wrapper (NvBlastTk), and extensions (prefixed with NvBlastExt). This layered API is designed to allow short ramp-up time for -first usage (through the Ext and Tk APIs) while also allowing for customization and optimization by experienced users through the -low-level API. - -This library is intended to replace APEX Destruction. It is being developed with the goal of addressing shortcomings in -performance, stability, and customizability of the APEX Destruction module. - -Some notable features of NvBlast: -* C-style API consisting of stateless functions, with no global framework or context. -* Functions do not spawn tasks, allocate, or deallocate memory. -* A support structure may be defined that includes chunks from different hierarchical depths. -* Multiple chunk hierarchies may exist in a single asset. -* Damage behavior is completely defined by user-supplied "shader" functions. -* Has a portable memory layout for assets and actor families, which allows for memcopy cloning and direct binary serialization (on platforms with the same endianness). - -Features of NvBlastTk: -* C++ API which includes a global framework. -* Manages objects, allocating and deallocating using a user-supplied callback. -* Generates "worker" objects to process damage, which the user may call from multiple threads. -* Uses an event system to inform the user of actor splitting and chunk fracturing. -* Introduces a joint representation which uses the event system to allow the user to update physical joints between actors. - -Notably absent from NvBlast and NvBlastTk: -* There is no physics or collision representation. -* There is no graphics representation. - -Blast, at the low-level and toolkit layer are physics and graphics agnostic. It is entirely up to the user to create such representations -when blast objects are created. Updates to those objects (such as actor splitting) are passed to the user as the output of a split -function in the low-level API, or through a split event in the toolkit API. This allows Blast to be used with any physics SDK and any -rendering library. - -In order to help the user get started quickly, however, there is a PhysX-specific Blast extension which uses BlastTk and manages PhysX actors -and joints. The source code for this extension, like all Blast extensions, is intended to be a reference implementation. - -Current blast extensions: -* ExtAssetUtils - NvBlastAsset utility functions. Add world bonds, merge assets, and transform geometric data. -* ExtAuthoring - a set of geometric tools which can split a mesh hierarchically and create a Blast asset, along with collision geometry and chunk graphics meshes in a separate files. -* ExtImport - provides functions to import an APEX Destructible Asset to create a Blast asset. -* ExtExporter - standard mesh and collision writer tools in fbx, obj, and json formats. -* ExtPhysX - a physics manager using PhysX which keeps PxActors and PxJoints updated in a user-supplied PxScene. It handles impact damage (through the contact callback), includes a stress solver wrapper, and provides a listener that enables multiple clients to keep their state synchronized. -* ExtSerialization, ExtTkSerialization, ExtPxSerialization - serialization extensions for low-level, Tk and Px layers. Uses Cap'n Proto to provide robust serialization across different platforms. -* ExtShaders - sample damage shaders to pass to both the low-level and Tk actor damage functions. -* ExtStress - a toolkit for performing stress calculations on low-evel Blast actors, using a minimal API to assign masses and apply forces. Does not use any external physics library. - -Documentation -------------- - -See the [Blast Online Documentation](http://gameworksdocs.nvidia.com/simulation.html#blast) for API and authoring documentation. - -In this repository, see [docs/source_docs/index.html](docs/source_docs/index.html) for full source doxygen pages, and [docs/release_notes.txt](docs/release_notes.txt) for changes. - -Compiling ---------- - -For windows (VS2015): -* Run `generate_projects_vc14winBB.bat`, where BB = 32 or 64, depending on which OS style (32 or 64 bit) you're targeting. -This step will download all necessary dependencies that are not already downloaded into a folder `NVIDIA/packman-repo` at the root of your hard drive, so -this might take some time the first time one of these scripts is run (or when a dependency version changes). -* Open `compiler/vc14winBB-cmake/BlastAll.sln`. This contains all Blast windows projects, including the -low-level, toolkit, extensions, tools, tests, and sample. -* If you run the sample, you should first run `download_sample_resources.bat`. This will load complex asset -files with nontrivial graphics meshes. Without these assets, only procedurally-generated box assets are available -in the sample. - -For linux: -* Run `generate_projects_linux.sh`. This step will download all necessary dependencies that are not already -downloaded into a folder `NVIDIA/packman-repo` at the root of your hard drive, so this might take some time the first -time the script is run (or when a dependency version changes). -* Makefiles will be generated in `compiler/linux64-CONFIG-gcc`, where CONFIG = debug or release. -These will build all Blast linux projects, including the low-level, toolkit, extensions, and tests. - -For PS4 and XBoxOne: -* Please visit https://developer.nvidia.com in order to contact NVIDIA for further information. - -Tools and Samples Binaries (Windows only) ------------------------------------------ - -Blast tools and sample executables, along with all necessary supporting libraries, are packaged in the -[blast_tools_and_samples-windows.zip](blast_tools_and_samples-windows.zip) file. This allows someone without a development environment to use these -applications. - -BlastTool-1.1 (Windows 64-bit only) ------------------------------------ - -BlastTool is a standalone GUI application for authoring Blast assets. It imports fbx graphics files and exports Blast assets in the low-level, high-level (Tk), -and ExtPx formats, along with fractured meshes and (optionally) collision geometry in a separate file or embedded in an fbx along with the graphics meshes. -To use it, unzip the [BlastTool-1.1_win64.zip](BlastTool-1.1_win64.zip) file. - -Documentation may be found here: http://gameworksdocs.nvidia.com/Blast/1.1/authoring_docs/index.html - -Unreal Engine 4 Plugin ----------------------- - -UE4.17.2: https://github.com/NvPhysX/UnrealEngine/tree/Blast-4.17 -UE4.18.0: https://github.com/NvPhysX/UnrealEngine/tree/Blast-4.18 - -UE4 github access is required to access this repo, more info: https://developer.nvidia.com/nvidia-gameworks-and-ue4 - -Includes authoring in UnrealEd and sample maps. - -Gallery -------- - -### Tower explosion - -### Bunny impact damage - -### Layered cube explosion - -### Table impact damage - -### Tower slice - -### Wall impact damage - -### Stress solver - -### Joints - +Blast 1.1.2
+===========
+
+
+
+Introduction
+------------
+
+Blast is a new NVIDIA GameWorks destruction library. It consists of three layers: the low-level (NvBlast), a high-level "toolkit"
+wrapper (NvBlastTk), and extensions (prefixed with NvBlastExt). This layered API is designed to allow short ramp-up time for
+first usage (through the Ext and Tk APIs) while also allowing for customization and optimization by experienced users through the
+low-level API.
+
+This library is intended to replace APEX Destruction. It is being developed with the goal of addressing shortcomings in
+performance, stability, and customizability of the APEX Destruction module.
+
+Some notable features of NvBlast:
+* C-style API consisting of stateless functions, with no global framework or context.
+* Functions do not spawn tasks, allocate, or deallocate memory.
+* A support structure may be defined that includes chunks from different hierarchical depths.
+* Multiple chunk hierarchies may exist in a single asset.
+* Damage behavior is completely defined by user-supplied "shader" functions.
+* Has a portable memory layout for assets and actor families, which allows for memcopy cloning and direct binary serialization (on platforms with the same endianness).
+
+Features of NvBlastTk:
+* C++ API which includes a global framework.
+* Manages objects, allocating and deallocating using a user-supplied callback.
+* Generates "worker" objects to process damage, which the user may call from multiple threads.
+* Uses an event system to inform the user of actor splitting and chunk fracturing.
+* Introduces a joint representation which uses the event system to allow the user to update physical joints between actors.
+
+Notably absent from NvBlast and NvBlastTk:
+* There is no physics or collision representation.
+* There is no graphics representation.
+
+Blast, at the low-level and toolkit layer are physics and graphics agnostic. It is entirely up to the user to create such representations
+when blast objects are created. Updates to those objects (such as actor splitting) are passed to the user as the output of a split
+function in the low-level API, or through a split event in the toolkit API. This allows Blast to be used with any physics SDK and any
+rendering library.
+
+In order to help the user get started quickly, however, there is a PhysX-specific Blast extension which uses BlastTk and manages PhysX actors
+and joints. The source code for this extension, like all Blast extensions, is intended to be a reference implementation.
+
+Current blast extensions:
+* ExtAssetUtils - NvBlastAsset utility functions. Add world bonds, merge assets, and transform geometric data.
+* ExtAuthoring - a set of geometric tools which can split a mesh hierarchically and create a Blast asset, along with collision geometry and chunk graphics meshes in a separate files.
+* ExtImport - provides functions to import an APEX Destructible Asset to create a Blast asset.
+* ExtExporter - standard mesh and collision writer tools in fbx, obj, and json formats.
+* ExtPhysX - a physics manager using PhysX which keeps PxActors and PxJoints updated in a user-supplied PxScene. It handles impact damage (through the contact callback), includes a stress solver wrapper, and provides a listener that enables multiple clients to keep their state synchronized.
+* ExtSerialization, ExtTkSerialization, ExtPxSerialization - serialization extensions for low-level, Tk and Px layers. Uses Cap'n Proto to provide robust serialization across different platforms.
+* ExtShaders - sample damage shaders to pass to both the low-level and Tk actor damage functions.
+* ExtStress - a toolkit for performing stress calculations on low-evel Blast actors, using a minimal API to assign masses and apply forces. Does not use any external physics library.
+
+Documentation
+-------------
+
+See [docs/api_docs/index.html](docs/api_docs/index.html) for api documentation.
+
+See [docs/source_docs/index.html](docs/source_docs/index.html) for full source doxygen pages.
+
+See [docs/release_notes.txt](docs/release_notes.txt) for changes.
+
+Compiling
+---------
+
+For windows (VS2015):
+* Run `generate_projects_vc14winBB.bat`, where BB = 32 or 64, depending on which OS style (32 or 64 bit) you're targeting.
+This step will download all necessary dependencies that are not already downloaded into a folder `NVIDIA/packman-repo` at the root of your hard drive, so
+this might take some time the first time one of these scripts is run (or when a dependency version changes).
+* Open `compiler/vc14winBB-cmake/BlastAll.sln`. This contains all Blast windows projects, including the
+low-level, toolkit, extensions, tools, tests, and sample.
+* If you run the sample, you should first run `download_sample_resources.bat`. This will load complex asset
+files with nontrivial graphics meshes. Without these assets, only procedurally-generated box assets are available
+in the sample.
+
+For linux:
+* Run `generate_projects_linux.sh`. This step will download all necessary dependencies that are not already
+downloaded into a folder `NVIDIA/packman-repo` at the root of your hard drive, so this might take some time the first
+time the script is run (or when a dependency version changes).
+* Makefiles will be generated in `compiler/linux64-CONFIG-gcc`, where CONFIG = debug or release.
+These will build all Blast linux projects, including the low-level, toolkit, extensions, and tests.
+
+For PS4 and XBoxOne:
+* Please visit https://developer.nvidia.com in order to contact NVIDIA for further information.
+
+Tools and Samples Binaries (Windows only)
+-----------------------------------------
+
+Blast tools and sample executables, along with all necessary supporting libraries, are packaged in the
+[blast_tools_and_samples-windows.zip](blast_tools_and_samples-windows.zip) file. This allows someone without a development environment to use these
+applications.
+
+BlastTool-1.1 (Windows 64-bit only)
+-----------------------------------
+
+BlastTool is a standalone GUI application for authoring Blast assets. It imports fbx graphics files and exports Blast assets in the low-level, high-level (Tk),
+and ExtPx formats, along with fractured meshes and (optionally) collision geometry in a separate file or embedded in an fbx along with the graphics meshes.
+To use it, unzip the [BlastTool-1.1_win64.zip](BlastTool-1.1_win64.zip) file.
+
+Documentation may be found here: http://gameworksdocs.nvidia.com/Blast/1.1/authoring_docs/index.html
+
+Unreal Engine 4 Plugin
+----------------------
+
+UE4.17.2: https://github.com/NvPhysX/UnrealEngine/tree/Blast-4.17
+UE4.18.0: https://github.com/NvPhysX/UnrealEngine/tree/Blast-4.18
+
+UE4 github access is required to access this repo, more info: https://developer.nvidia.com/nvidia-gameworks-and-ue4
+
+Includes authoring in UnrealEd and sample maps.
+
+Gallery
+-------
+
+### Tower explosion
+
+### Bunny impact damage
+
+### Layered cube explosion
+
+### Table impact damage
+
+### Tower slice
+
+### Wall impact damage
+
+### Stress solver
+
+### Joints
+
|