Scroll to navigation

F3D(1) User Commands F3D(1)

NAME

F3D - fast and minimalist 3D viewer

DESCRIPTION

F3D - A fast and minimalist 3D viewer Usage:

f3d [OPTIONS...] file1 file2 ...
Applicative options:
Input files
Define libf3d options
Reset libf3d options
Render to file
No background when render to file (default: false)
Print help
Print version details
Print the list of readers
Force a specific reader to be used, disregarding the file extension
Print the list of interaction bindings and exits, ignored with `--no-render`, only considers the first file group. (default: false)
Specify the configuration file to use. absolute/relative path or filename/filestem to search in configuration file locations
Do not read the configuration file (default: false)
Do not render anything and quit right after loading the first file, use with --verbose to recover information about a file. (default: false)
Backend to use when rendering (auto|glx|wgl|egl|osmesa) (default: auto)
Print the list of rendering backends available on this system
Maximum size in Mib of a file to load, leave empty for unlimited
Watch current file and automatically reload it whenever it is modified on disk (default: false)
Frame rate used to refresh animation and other repeated tasks (watch, UI). Does not impact rendering frame rate. (default: 30.0)
List of plugins to load separated with a comma
Scan standard directories for plugins and display available plugins (result can be incomplete)
Screenshot filename (default: {app}/{model}_{n}.png)
General options:
Set verbose level, providing more information about the loaded data in the console output (default: info)
Show loading progress bar (default: false)
Show animation progress bar (default: false)
Choose the behavior when opening multiple files. "single" will show one file at a time, "all" will show all files in a single scene, "dir" will show files from the same directory in the same scene. (default: single)
Up direction (default: +Y)
Show axes (default: false)
Show grid (default: false)
Position grid at the absolute origin instead of below the model (default: false)
Size of grid unit square, automatically computed by default
Number of grid subdivisions (default: 10)
Color of main grid lines (default: #000000)
Show cell edges
Enable armature visualization (default: false)
Select the camera to use
Enable trackball interaction (default: false)
Invert zoom direction with right mouse click (default: false)
Automatically start animation (default: false)
Select animation to show (deprecated) (default: 0)
Select animations to show (default: 0)
Set animation speed factor (default: 1)
Set animation time to load
Path to a FreeType compatible font file
Scale fonts (default: 1)
Path to a script file containing commands to execute
Material options:
Show sphere sprites instead of surfaces (default: false)
Point sprites type (default: sphere)
Point sprites size (default: 10)
Point size when showing vertices, model specified by default
Line width when showing edges, model specified by default
Backface type, can be visible or hidden, model specified by default
Solid color
Opacity
Roughness coefficient (0.0-1.0)
Metallic coefficient (0.0-1.0)
Index Of Refraction of the base layer (1.0-2.5)
Path to an image file that can be used as a light source and skybox
Enable HDRI ambient lighting (default: false)
Enable HDRI skybox background (default: false)
Path to a texture file containing a material capture
Path to a texture file that sets the color of the object
Path to a texture file that sets the Occlusion, Roughness and Metallic values of the object
Path to a texture file that sets the emitted light of the object
3x3 matrix to transform textures
Emissive factor. This value is multiplied with the emissive color when an emissive texture is present
Path to a texture file that sets the normal map of the object
Normal scale affects the strength of the normal deviation from the normal texture
Window options:
Background color (default: #333333)
Window resolution (default: 1000, 600)
Window position
Display rendering frame per second (default: false)
Display filename (default: false)
Display file metadata (default: false)
Blur background (default: false)
Blur circle of confusion radius (default: 20)
Light intensity (default: 1)
Scientific visualization options:
Color by a scalar array (default: false)
Name of the array to color with
Component from the array to color with. -1 means magnitude, -2 or the short option, -y, means direct scalars (default: -1)
Use an array from the cells (default: false)
Custom range for the coloring by array, automatically computed by default
Show scalar bar (default: false)
Specify a colormap image
Specify number of colors in colormap
Specify a custom colormap (ignored if "colormap-file" is specified) (default: 0,#000000,0.4,0.9,0,0,0.8,0.9,0.9,0,1,#fffff f)
Show volume if the file is compatible (default: false)
Inverse opacity function for volume rendering (default: false)
Camera options:
Camera position (overrides camera direction and camera zoom factor if any)
Camera focal point
Camera view up
Camera view angle (non-zero, in degrees) (default: 0.0)
Camera direction
Camera zoom factor (non-zero) (default: 0.0)
Camera azimuth angle (in degrees), performed after other camera options (default: 0.0)
Camera elevation angle (in degrees), performed after other camera options (default: 0.0)
Use an orthographic camera
PostFX (OpenGL) options:
Enable translucency support, implemented using depth peeling (default: false)
Enable ambient occlusion providing approximate shadows for better depth perception, implemented using SSAO (default: false)
Enable anti-aliasing (default: false)
Select anti-aliasing method ("fxaa" or "ssaa") (default: fxaa)
Enable Tone Mapping, providing balanced coloring (default: false)
Execute the final shader at the end of the rendering pipeline
Testing options:
Reference
Testing threshold (default: 0.04)
Path to an interaction log file to record interactions events to
Path to an interaction log file to play interaction events from when loading a file

EXAMPLES

View a unstructured mesh in a typical nice looking sciviz style
View a gltf file in a realistic environment
View a point cloud file with direct scalars rendering
View all files in folder

REPORTING BUGS

Report bugs to https://github.com/f3d-app/f3d/issues

F3D - A fast and minimalist 3D viewer
Version: 3.2.0.
Build date: 2025-11-16 11:47:09.
Build system: Linux 64-bits.
Compiler: GNU 15.2.0.
Module ImGui: ON.
Module OpenEXR: OFF.
Module Raytracing: OFF.
VTK version: 9.5.2.
Copyright © 2019-2021 Kitware SAS.
Copyright © 2021-2025 Michael Migliore, Mathieu Westphal.
License BSD-3-Clause.

November 2025 F3D 3.2.0