https://github.com/nvidiagameworks/flex

https://github.com/nvidiagameworks/flex

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nvidiagameworks/flex
• Owner: NVIDIAGameWorks
• License: other
• Created: 2017-01-24T21:51:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-04-15T01:36:31.000Z (over 3 years ago)
• Last Synced: 2024-08-04T02:09:27.248Z (3 months ago)
• Language: C++
• Size: 305 MB
• Stars: 652
• Watchers: 75
• Forks: 100
• Open Issues: 95
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
NVIDIA Flex - 1.2.0

===================

Flex is a particle-based simulation library designed for real-time applications.

Please see the programmer's manual included in this release package for more information on

the solver API and usage.

Supported Platforms

-------------------

* Windows 32/64 bit (CUDA, DX11, DX12)

* Linux 64 bit (CUDA, tested with Ubuntu 16.04 LTS and Mint 17.2 Rafaela)

Requirements

------------

A D3D11 capable graphics card with the following driver versions:

* NVIDIA GeForce Game Ready Driver 396.45 or above

* AMD Radeon Software Version 16.9.1 or above

* Intel® Graphics Version 15.33.43.4425 or above

To build the demo at least one of the following is required:

* Microsoft Visual Studio 2013

* Microsoft Visual Studio 2015

* g++ 4.6.3 or higher

And either: 

* CUDA 9.2.148 toolkit

* DirectX 11/12 SDK

Demo 

====

Use the `run_cuda.bat` or `run_d3d.bat` files to launch the demo.

Notes 

-----

* Some scenes also have fluid emitters that can be started using 'space'

* For running the Linux binaries you will need to export the path to where the CUDA run time libraries are

  For example, you may add to your .bashrc file the following:

       

      export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64

Command Line Options

--------------------

The following commands may be passed to the demo application to modify behavior:

    -fullscreen=wxh  Start fullscreen e.g.: -fullscreen=1280x720

    -msaa=0          Disable multisampling (default is on)

    -device=n        Choose GPU to run on

    -d3d12           Enable D3D12 compute

    -benchmark       Enable bencmark mode, will write a benchmark.txt to the root folder

    -vsync=0         Disable vsync

Controls

--------

    w,s,a,d - Fly Camera

    right mouse - Mouse look

    shift + left mouse - Particle select and drag

    p - Pause/Unpause

    o - Step

    h - Hide/Show onscreen help

    

    left/right arrow keys - Move to prev/next scene

    up/down arrow keys - Select next scene

    enter - Launch selected scene

    r - Reset current scene

    

    e - Draw fluid surface

    v - Draw points

    f - Draw springs

    i - Draw diffuse

    m - Draw meshes

    

    space - Toggle fluid emitter

    y - Toggle wave pool

    c - Toggle video capture

    u - Toggle fullscreen

    j - Wind gust

    - - Remove a plane

    esc - Quit

Known Issues

============

* Crash with inflatable scenes on Intel HD Graphics 530

* MSAA is broken on D3D12 and currently disabled

Acknowledgements

================

* SDL is licensed under the zlib license

* GLEW is licensed under the Modified BSD license

* Regal is licensed under the BSD license

* stb_truetype by Sean Barrett is public domain

* imgui by Mikko Mononen is licensed under the ZLib license