Skip to main content
Version: 🚧 Nightly

Plugins and modules

Plugins​

An F3D plugin is an optional component that adds support for one or more file readers. If you installed F3D using the binary release, you do not need to load these plugins manually when opening your file. F3D loads them automatically.

However, if you installed F3D using a package manager, the packager may bundle the plugins into different packages or list plugin dependencies as optional to reduce the number of dependencies of the main package.

To open a file that requires a plugin, first install all necessary dependencies. Then load the plugin with the --load-plugins=<path or name> command-line option.

Alternatively, add your plugin directly in the configuration file if it isn't there already. You can specify one or multiple plugins in a single comma-separated list, like in the example below:

[
{
"match": ".*(file_extension)",
"options": {
"load-plugins": "plugin1,plugin2"
}
}
]

Supported plugins​

F3D supports loading plugins and contains the following plugins: native, alembic, assimp, draco, hdf, occt, pdal, usd, vdb, webifc.

See the supported file formats page for more details.

note

The native plugin is always loaded automatically. If you downloaded the binaries from the release page, you do not need to specify the plugins above manually. F3D loads them automatically.

Plugin availability per binary​

Not every binary ships every plugin, so a file may open in one binary but not another. This table shows which plugins are available in each official binary. The native plugin is always present.

PluginDesktopPython wheelnpm / WebAssemblyAndroid
nativeYesYesYesYes
alembicYesYesYesYes
assimpYesYesYesYes
dracoYesYesYesYes
hdfYesYesYesYes
occtYesYesYesYes
pdalYesYesNoNo
usdYesYesYesYes (64-bits only)
vdbYesYesYesYes
webifcYesYesYesYes

F3D searches for plugins in this order:

  1. Search the static plugins.
  2. Use the load-plugins option when it is a full path.
  3. Search the paths specified in the --plugins-path CLI option.
  4. Search a directory relative to F3D: ../lib.
  5. Rely on OS-specific paths (e.g. LD_LIBRARY_PATH on Linux or DYLD_LIBRARY_PATH on macOS).

You can also try plugins maintained by the community. If you have created a plugin and want it listed here, submit a pull request.

Modules​

An F3D module is an optional component that adds a specific feature to the application or the library. It usually comes with a dependency on a library or a non-generic VTK module. They are enabled when configuring and compiling the project.

Module list​

F3D supports the following modules:

  • ANARI: Supports experimental Anari renderer, requires VTK RenderingAnariOpenGL module.
  • CLIP: Supports clipboard operations, required clip library (vendored).
  • DMON: Supports --watch option, requires dmon library (vendored).
  • EXR: Supports .exr images, required OpenEXR library.
  • FFMPEG: Supports --output-video and f3d::video_* API.
  • MESHOPT: Supports GLTF meshopt_compression extension, requires meshoptimizer library.
  • OPENXR: Supports experimental OpenXR rendering backend, requires VTK RenderingOpenXR module.
  • RAYTRACING: Supports --raytracing option, requires VTK RenderingRayTracing module.
  • TINYFILEDIALOGS: Supports open/save dialogs, requires tinyfiledialogs library (vendored).
  • UI: Supports UI widgets, requires imgui library (vendored).
  • WEBP: Supports .webp images, requires libwebp library.

Modules are enabled by default for modules with vendored libraries.

Module availability per binary​

Not every binary ships every module. This table shows which modules are available in each official binary.

PluginDesktopPython wheelnpm / WebAssemblyAndroid
ANARINoNoNoNo
CLIPYesYesN/AN/A
DMONYesN/AN/AN/A
EXRYesYesYesYes
FFMPEGYesYesNoNo
MESHOPTNoNoYesNo
OPENXRNoNoNoNo
RAYTRACINGYesNoNoNo
TINYFILEDIALOGSYesYesN/AN/A
UIYesYesNoNo
WEBPYesYesYesYes