cubbyflow / renderflow

Visualize fluid simulation result with graphics API

RenderFlow

RenderFlow is fluid visualization project for CubbyFlow.

QuickStart

RenderFlow need CubbyFlow dependency. You need to install CubbyFlow before configuration

git clone https://github.com/CubbyFlow/CubbyFlow.git --recursive
mkdir CubbyFlow/build CubbyFlow/install
cd CubbyFlow/build
cmake .. -DCMAKE_INSTALL_PREFIX=../install
cmake --build . --target install

After install header & library of the CubbyFlow, Now you can configure RenderFlow.

git clone https://github.com/CubbyFlow/RenderFlow.git --recursive
cd RenderFlow
mkdir build
cd build
cmake .. -DCUBBYFLOW_INSTALL_DIR=${DIR_YOU_INSTALLED} -DCMAKE_TOOLCHAIN_FILE=${PATH_TO_VCPKG}"scripts/buildsystems/vcpkg.cmake" && make

Vcpkg dependency

• CubbyFlow
• cxxopts
• glad[gl-api-45]
• glfw3
• imgui
• tinyobjloader

One line vcpkg dependency installation

vcpkg install glad[gl-api-45]:{YOUR_ARCH} glfw3:{YOUR_ARCH} glm:{YOUR_ARCH} imgui:{YOUR_ARCH} tinyobjloader:{YOUR_ARCH}

Other dependency

• tinygltf
• doctest

How To Contribute

Contributions are always welcome, either reporting issues/bugs or forking the repository and then issuing pull requests when you have completed some additional coding that you feel will be beneficial to the main project. If you are interested in contributing in a more dedicated capacity, then please contact me.

Contact

You can contact me via e-mail (sinjihng at gmail.com). I am always happy to answer questions or help with any issues you might have, and please be sure to share any additional work or your creations with me, I love seeing what other people are making.

License

The class is licensed under the MIT License:

RenderFlow project's scene and skydome are largely referenced on vk_shaded_gltfscene

Copyright (c) 2021 Snowapril

• Jihong Shin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

renderflow's Issues

Point Cloud Rendering

SPIR-V Support

Would RenderFlow continue to develop?

It seems RenderFlow did not function well yet... So would it to be updated in the future? ^_^

CubbyFlow Scene Editor

Fluid Attribute Visualization

Support visualization of fluid attributes, such as density, pressure.

UnitTesting Supports

• Add unit testing with doctest framework

Replace glm dependency with CubbyFlow

Vulkan API Support

Multiple graphics API support will enhance project's diversity.