Desktop Integration

F3D can be integrated in the desktop experience.

Linux

For Linux desktop integration, F3D rely on mime types files as defined by the XDG standard, .thumbnailer file as specified here and .desktop file as specified here. Many file managers use this mechanism, including nautilus, thunar, pcmanfm and caja.

The simplest way to obtain desktop integration on Linux is to use a package for your distribution, or the .deb binary release package we provide if compatible with your distribution. In other cases, the binary release archive can be used like this:

1. Make sure ~/.local/bin is part of your PATH
2. Extract F3D binary release archive in ~/.local/
3. Update your mime database pointing to ~/.local/share/mime
4. Update your desktop database pointing to ~/.local/share/application

export PATH=$PATH:~/.local/bin
tar -xzvf f3d-1.3.0-Linux.tar.gz -C ~/.local/
update-mime-database ~/.local/share/mime/
update-desktop-database ~/.local/share/applications

If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses bwrap and gives it access to /usr but not to /opt.

Windows

For Windows desktop integration, F3D rely on a registered shell extension.

Using the F3D NSIS installer (.exe) is the simplest way to enable thumbnails and integrate F3D on windows.

It is also possible to do it manually when using the zipped binary release archive, on installation, just run:

cd C:\path\to\f3d\bin\
regsvr32 F3DShellExtension.dll

To remove the shell extension, run:

cd C:\path\to\f3d\bin\
regsvr32 /u F3DShellExtension.dll

MacOS

There is no support for thumbnails on MacOS, the .dmg binary release provides automatic file openings.

Rendering backends

F3D supports rendering in environments with limited graphical contexts, including sandboxes or without Xorg running on Linux. In most cases, the default behavior will automatically detect which capabilities are available and use the right rendering backend, it is possible to specify it using the --rendering-backend CLI option.

• If EGL is available, you can use: --rendering-backend=egl. The following libraries are attempted to be loaded dynamically (in that order):
  • libEGL.so.1, libEGL.so on Linux
  • libEGL.dll, EGL.dll on Windows
• If OSMesa is available, you can use: --rendering-backend=osmesa. The following libraries are attempted to be loaded dynamically (in that order):
  • libOSMesa.so.8, libOSMesa.so.6, libOSMesa.so on Linux
  • osmesa.dll on Windows
  • libOSMesa.8.dylib, libOSMesa.6.dylib, libOSMesa.dylib on macOS
• When using --rendering-backend=auto, F3D have the following logic:
  • On Linux, check if a X server is running, in which case GLX is used. Otherwise, try to load EGL library and fallback on OSMesa if not available.
  • On Windows, check if the OpenGL driver supports OpenGL 3.2, in which case WGL is used. Otherwise, try to load EGL library and fallback on OSMesa if not available.
  • On macOS, always use COCOA. To use OSMesa, you must use --rendering-backend=osmesa.

You can use that feature for thumbnail generation whenever needed (e.g., Nautilus or other sandboxing file browser), by creating/modifying your thumbnail config file, eg:~/.config/f3d/thumbnail.json:

[
  {
    "options": {
      "rendering-backend": "egl"
    }
  }
]

Limitations

• TIFF files are excluded from the thumbnailer to avoid conflicts with other better 2D thumbnailers.