A mirror for F3D
 
 
 
 
 
 
Go to file
Mathieu Westphal bdf5253b1c
Merge pull request #1030 from f3d-app/release
2.2.0 version (#1029)
2023-10-01 23:45:57 +02:00
.github upload coverage test results (#1026) 2023-10-01 12:35:40 +02:00
_includes Fix google analytics (#482) 2022-11-12 18:53:58 +01:00
application Merge pull request #1023 from mwestphal/reset_on_load_empty 2023-10-01 13:19:52 +02:00
cmake Avoid installation of useless files (#922) 2023-07-18 23:48:12 +02:00
doc Adding a Getting Started guide (#999) 2023-09-29 17:23:05 +02:00
examples Update min cmake version to avoid ci warning (#931) 2023-07-28 00:05:18 +02:00
external Add options to use external libraries of nlohmann-json and cxxopts (#832) 2023-06-01 07:24:43 +02:00
java Fix F3D build when added as a subproject (#899) 2023-07-07 11:24:10 +02:00
library Merge pull request #1023 from mwestphal/reset_on_load_empty 2023-10-01 13:19:52 +02:00
plugins OCC BRep format (#946) 2023-08-23 07:44:43 +02:00
python Fix python testing 2023-10-01 10:59:07 +02:00
resources Add Default HDRI and use it in config file (#950) 2023-08-29 10:57:32 +02:00
testing Reset the loader when loading an invalid file 2023-10-01 11:30:51 +02:00
webassembly Fix F3D build when added as a subproject (#899) 2023-07-07 11:24:10 +02:00
winshellext Fix F3D build when added as a subproject (#899) 2023-07-07 11:24:10 +02:00
.clang-format Improve CMake file to include packaging 2019-11-05 13:13:53 +01:00
.clang-tidy Static analysers in CI (#329) 2023-05-11 16:36:16 +02:00
.codespellrc Add typo suggestion (#852) 2023-06-19 10:05:58 +02:00
.cppcheck.supp fix cppcheck 2023-07-11 17:30:08 +08:00
.gitattributes Improving plugin CI 2023-04-17 15:34:31 +02:00
.gitignore Improve Python integration (#962) 2023-09-05 19:28:10 +02:00
.lsan.supp Update VTK CI and Package (#838) 2023-06-13 11:43:05 +02:00
.tsan.supp Update VTK CI and Package (#838) 2023-06-13 11:43:05 +02:00
CMakeLists.txt 2.2.0 version (#1029) 2023-10-01 19:15:30 +02:00
CNAME Create CNAME 2022-11-14 11:03:40 +01:00
CONTRIBUTING.md Adding a Getting Started guide (#999) 2023-09-29 17:23:05 +02:00
LICENSE.md Update copyright year (#742) 2023-04-20 12:07:07 +02:00
README.md Update website for 2.0.0 (#745) 2023-04-21 11:32:37 +02:00
_config.yml Adding a Getting Started guide (#999) 2023-09-29 17:23:05 +02:00
_licenses.md Fix hamburger layout website (#485) 2022-11-13 18:29:49 +01:00
codecov.yml Rework CI (#198) 2022-01-11 22:14:45 +01:00
pyproject.toml 2.2.0 version (#1029) 2023-10-01 19:15:30 +02:00
vcpkg.json Support for wider channel size in f3d::image (#858) 2023-07-10 15:26:02 +02:00

README.md

CI Packaging codecov Downloads Sponsors Discord

F3D - Fast and minimalist 3D viewer

By Michael Migliore and Mathieu Westphal.

F3D (pronounced `/fɛd/`) is a fast and minimalist 3D viewer. It supports many file formats, from digital content to scientific datasets (including glTF, STL, STEP, PLY, OBJ, FBX, Alembic), can show animations and support thumbnails and many rendering and texturing options including real time physically based rendering and raytracing.

It is fully controllable from the command line and support configuration files. It can provide thumbnails, support interactive hotkeys, drag&drop and integration into file managers.

F3D also contains the libf3d, a simple library to render meshes, with C++ and Python Bindings, as well as experimental Java and Javascript bindings.

A typical render by F3D

Animation of a glTF file within F3D

A direct scalars render by F3D

See the gallery for more images, take a look at the changelog or go to the releases page to download F3D!

If you need any help or want to discuss with other F3D users and developers, head over to our discord.

Quickstart

Open a file and visualize it interactively:

f3d /path/to/file.ext

Open a file and save the rendering into an image file:

f3d /path/to/file.ext --output=/path/to/img.png

Get help:

f3d --help
man f3d # Linux only

Documentation

  • To get started, please take a look at the user documentation.
  • If you need any help, are looking for a feature or found a bug, please open an issue.
  • If you want to use the libf3d, please take a look at its documentation.
  • If you want to build F3D, please take a look at the developer documentation.

Support

F3D is developed by a team of passionate devs. Please use F3D, star it on github or even become a sponsor to support us!

Contributing

We envision F3D as a community-driven project, we love to see how the project is growing thanks to the contributions from the community. We would love to see your face in the list below! If you want to contribute to F3D, you are very welcome to! Take a look at our contribution documentation.

Acknowledgments

F3D was initially created by Kitware SAS and is relying on many awesome open source projects, including VTK, OCCT, Assimp, Alembic, Draco and OSPRay.

License

F3D can be used and distributed under the 3-Clause BSD License, see the license. F3D integrate the sources of other libraries and tools, all under permissive licenses, see the third party licenses. F3D packages relies on other libraries and tools, all under permissive licenses, all listed in the respective packages.