Update README.md
This commit is contained in:
46
README.md
46
README.md
@@ -1,44 +1,46 @@
|
|||||||
[](https://travis-ci.org/bulletphysics/bullet3)
|
[](https://travis-ci.org/bulletphysics/bullet3)
|
||||||
[](https://ci.appveyor.com/project/erwincoumans/bullet3)
|
[](https://ci.appveyor.com/project/erwincoumans/bullet3)
|
||||||
|
|
||||||
Bullet 3.x GPU rigid body pipeline using OpenCL.
|
# Bullet 3.x GPU rigid body pipeline using OpenCL.
|
||||||
|
|
||||||
Note that the Bullet 2.x svn repository from http://bullet.googlecode.com
|
Note that the Bullet 2.x svn repository from http://bullet.googlecode.com
|
||||||
is being merged into this repository.
|
is being merged into this repository.
|
||||||
|
|
||||||
1) The old Bullet2 demos are moved from ObsoleteDemos to AllBullet2Demos
|
1. The old Bullet2 demos are moved from ObsoleteDemos to AllBullet2Demos
|
||||||
2) A new Bullet 3 API is created
|
2. A new Bullet 3 API is created
|
||||||
3) All Bullet2 functionality is added to Bullet 3
|
3. All Bullet2 functionality is added to Bullet 3. Until this is done, you can use the Demos3/BasicGpuDemo/b3GpuDynamicsWorld or explore the Demos3/GpuDemos to check out Bullet 3.
|
||||||
Until this is done, you can use the Demos3/BasicGpuDemo/b3GpuDynamicsWorld
|
|
||||||
or explore the Demos3/GpuDemos to check out Bullet 3.
|
|
||||||
|
|
||||||
You can still use svn or svn externals using the github git repository: use svn co https://github.com/erwincoumans/bullet3/trunk
|
You can still use svn or svn externals using the github git repository: use svn co https://github.com/erwincoumans/bullet3/trunk
|
||||||
|
|
||||||
The entire collision detection and rigid body dynamics is executed on the GPU.
|
The entire collision detection and rigid body dynamics is executed on the GPU.
|
||||||
|
|
||||||
Requirements:
|
## Requirements
|
||||||
|
|
||||||
A high-end desktop GPU, such as an AMD Radeon 7970 or NVIDIA GTX 680 or similar.
|
A high-end desktop GPU, such as an AMD Radeon 7970 or NVIDIA GTX 680 or similar.
|
||||||
We succesfully tested the software under Windows, Linux and Mac OSX.
|
We succesfully tested the software under Windows, Linux and Mac OSX.
|
||||||
The software currently doesn't work on OpenCL CPU devices. It might run
|
The software currently doesn't work on OpenCL CPU devices. It might run
|
||||||
on a laptop GPU but performance is likely not very good.
|
on a laptop GPU but performance is likely not very good.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
License
|
|
||||||
All source code files are licensed under the permissive zlib license
|
All source code files are licensed under the permissive zlib license
|
||||||
(http://opensource.org/licenses/Zlib) unless marked differently in a particular folder/file.
|
(http://opensource.org/licenses/Zlib) unless marked differently in a particular folder/file.
|
||||||
|
|
||||||
|
|
||||||
Build instructions:
|
## Build instructions
|
||||||
|
|
||||||
|
**Windows**
|
||||||
|
|
||||||
Windows:
|
|
||||||
Click on build3/vs2010.bat and open build3/vs2010/0MySolution.sln
|
Click on build3/vs2010.bat and open build3/vs2010/0MySolution.sln
|
||||||
|
|
||||||
Linux and Mac OSX gnu make
|
**Linux and Mac OSX gnu make**
|
||||||
|
|
||||||
In a terminal type:
|
In a terminal type:
|
||||||
|
|
||||||
cd build3
|
cd build3
|
||||||
|
|
||||||
Dependend on your system (Linux 32bit, 64bit or Mac OSX) use one of the following lines
|
Dependend on your system (Linux 32bit, 64bit or Mac OSX) use one of the following lines
|
||||||
|
|
||||||
./premake4_linux gmake
|
./premake4_linux gmake
|
||||||
./premake4_linux64 gmake
|
./premake4_linux64 gmake
|
||||||
./premake4_osx gmake
|
./premake4_osx gmake
|
||||||
@@ -48,18 +50,19 @@ Then
|
|||||||
cd gmake
|
cd gmake
|
||||||
make
|
make
|
||||||
|
|
||||||
Mac OSX Xcode
|
**Mac OSX Xcode**
|
||||||
|
|
||||||
Click on build3/xcode4.command or in a terminal window execute
|
Click on build3/xcode4.command or in a terminal window execute
|
||||||
|
|
||||||
./premake_osx xcode4
|
./premake_osx xcode4
|
||||||
|
|
||||||
Usage:
|
## Usage
|
||||||
|
|
||||||
The main demo executable will be located in the bin folder.
|
The main demo executable will be located in the bin folder.
|
||||||
The demo starts with App_Bullet3_OpenCL_Demos_*
|
The demo starts with App_Bullet3_OpenCL_Demos_*
|
||||||
|
|
||||||
You can just run it though a terminal/command prompt, or by clicking it.
|
You can just run it though a terminal/command prompt, or by clicking it.
|
||||||
|
|
||||||
|
|
||||||
There are some command-line options, you can see using the --help option. For example, this will perform a benchmark writing to some files:
|
There are some command-line options, you can see using the --help option. For example, this will perform a benchmark writing to some files:
|
||||||
|
|
||||||
./App_Bullet3_OpenCL_Demos_clew_gmake --benchmark
|
./App_Bullet3_OpenCL_Demos_clew_gmake --benchmark
|
||||||
@@ -91,18 +94,18 @@ Press F1 to create a screenshot. Hit ESCAPE to exit the demo app.
|
|||||||
|
|
||||||
Bullet 3.x only implements a small set of collision shapes and constraints:
|
Bullet 3.x only implements a small set of collision shapes and constraints:
|
||||||
|
|
||||||
Static plane
|
* Static plane
|
||||||
Static concave triangle mesh
|
* Static concave triangle mesh
|
||||||
Sphere
|
* Sphere
|
||||||
Convex Polyhedron
|
* Convex Polyhedron
|
||||||
Compound of Convex Polyhedra
|
* Compound of Convex Polyhedra
|
||||||
|
|
||||||
Bullet 3.x uses the separating axis test (SAT) between convex polyhedra, testing all vertex - face and edge - edge combinations. For performance it is best to keep the number of edges in a convex polyhedron low, using simple shapes such as a tetrahedron or a box.
|
Bullet 3.x uses the separating axis test (SAT) between convex polyhedra, testing all vertex - face and edge - edge combinations. For performance it is best to keep the number of edges in a convex polyhedron low, using simple shapes such as a tetrahedron or a box.
|
||||||
|
|
||||||
The constraint solver currently supports two constraints:
|
The constraint solver currently supports two constraints:
|
||||||
|
|
||||||
point to point constraint (ball-socket
|
* point to point constraint (ball-socket
|
||||||
fixed constraint
|
* fixed constraint
|
||||||
|
|
||||||
It can be extended to other constraint types. The constraint solver uses the same algorithm as Bullet 2.x.
|
It can be extended to other constraint types. The constraint solver uses the same algorithm as Bullet 2.x.
|
||||||
|
|
||||||
@@ -110,4 +113,3 @@ It is possibly to try out Bullet 3.x using the Bullet 2.x API, using the b3GpuDy
|
|||||||
Copy the source code of both versions in the same location, and click on build3/vs2010_bullet2gpu.bat to generate Visual Studio project files.
|
Copy the source code of both versions in the same location, and click on build3/vs2010_bullet2gpu.bat to generate Visual Studio project files.
|
||||||
|
|
||||||
See docs folder for further information.
|
See docs folder for further information.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user