.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH F3D "1" "January 2026" "F3D 3.4.1" "User Commands"
.SH NAME
F3D \- fast and minimalist 3D viewer
.SH DESCRIPTION
F3D \- A fast and minimalist 3D viewer
Usage:
.IP
f3d [OPTIONS...] file1 file2 ...
.IP
Applicative options:
.TP
\fB\-\-input\fR <files>
Input files
.TP
\fB\-D\fR, \fB\-\-define\fR libf3d.option=value
Define libf3d options
.TP
\fB\-R\fR, \fB\-\-reset\fR libf3d.option
Reset libf3d options
.TP
\fB\-\-output\fR <png file>
Render to file
.TP
\fB\-\-no\-background\fR [=<bool>(=1)]
No background when render to file (default:
false)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help
.TP
\fB\-\-version\fR
Print version details
.TP
\fB\-\-list\-readers\fR
Print the list of readers
.TP
\fB\-\-force\-reader\fR [=<reader>(=1)]
Force a specific reader to be used,
disregarding the file extension
.TP
\fB\-\-list\-bindings\fR [=<bool>(=1)]
Print the list of interaction bindings and
exits, ignored with `\-\-no\-render`, only
considers the first file group. (default:
false)
.TP
\fB\-\-config\fR <filePath/filename/fileStem>
Specify the configuration file to use.
absolute/relative path or filename/filestem
to search in configuration file locations
.TP
\fB\-\-no\-config\fR [=<bool>(=1)]
Do not read the configuration file
(default: false)
.TP
\fB\-\-no\-render\fR [=<bool>(=1)]
Do not render anything and quit right after
loading the first file, use with \fB\-\-verbose\fR
to recover information about a file.
(default: false)
.TP
\fB\-\-rendering\-backend\fR <string>
Backend to use when rendering
(auto|glx|wgl|egl|osmesa) (default: auto)
.TP
\fB\-\-list\-rendering\-backends\fR
Print the list of rendering backends
available on this system
.TP
\fB\-\-max\-size\fR <size in Mib>
Maximum size in Mib of a file to load,
leave empty for unlimited
.TP
\fB\-\-watch\fR [=<bool>(=1)]
Watch current file and automatically reload
it whenever it is modified on disk
(default: false)
.TP
\fB\-\-frame\-rate\fR <fps>
Frame rate used to refresh animation and
other repeated tasks (watch, UI). Does not
impact rendering frame rate. (default:
30.0)
.TP
\fB\-\-load\-plugins\fR <paths or names>
List of plugins to load separated with a
comma
.TP
\fB\-\-scan\-plugins\fR
Scan standard directories for plugins and
display available plugins (result can be
incomplete)
.TP
\fB\-\-screenshot\-filename\fR <filename>
Screenshot filename (default:
{app}/{model}_{n}.png)
.IP
General options:
.TP
\fB\-\-verbose\fR [={debug, info, warning, error, quiet}(=debug)]
Set verbose level, providing more
information about the loaded data in the
console output (default: info)
.TP
\fB\-\-loading\-progress\fR [=<bool>(=1)]
Show loading progress bar (default: false)
.TP
\fB\-\-animation\-progress\fR [=<bool>(=1)]
Show animation progress bar (default:
false)
.TP
\fB\-\-multi\-file\-mode\fR <single|all|dir>
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)
.TP
\fB\-\-multi\-file\-regex\fR <regex>
Regular expression pattern to group files.
Captured groups are replaced with "*" so
that, for example, the pattern "part(\ed+)"
would group files "foo\-part1.xyz" and
"foo\-part2.xyz" together as "foo\-part*.xyz"
.TP
\fB\-\-recursive\-dir\-add\fR [=<bool>(=1)]
Add directories recursively (default:
false)
.TP
\fB\-\-remove\-empty\-file\-groups\fR [=<bool>(=1)]
Remove file groups that results into an
empty scene (default: false)
.TP
\fB\-\-up\fR <direction>
Up direction (default: +Y)
.TP
\fB\-x\fR, \fB\-\-axis\fR [=<bool>(=1)]
Show axes (default: false)
.TP
\fB\-g\fR, \fB\-\-grid\fR [=<bool>(=1)]
Show grid (default: false)
.TP
\fB\-\-x\-color\fR <color>
Color of the X axis (default: #f94306)
.TP
\fB\-\-y\-color\fR <color>
Color of the Y axis (default: #7aff7a)
.TP
\fB\-\-z\-color\fR <color>
Color of the Z axis (default: #788bff)
.TP
\fB\-\-grid\-absolute\fR [=<bool>(=1)]
Position grid at the absolute origin
instead of below the model (default: false)
.TP
\fB\-\-grid\-unit\fR <value>
Size of grid unit square, automatically
computed by default
.TP
\fB\-\-grid\-subdivisions\fR <value>
Number of grid subdivisions (default: 10)
.TP
\fB\-\-grid\-color\fR <color>
Color of main grid lines (default: #000000)
.TP
\fB\-\-axes\-grid\fR [=<bool>(=1)]
Enable grid axis (default: false)
.TP
\fB\-e\fR, \fB\-\-edges\fR [=<bool>(=1)]
Show cell edges
.TP
\fB\-\-armature\fR [=<bool>(=1)]
Enable armature visualization (default:
false)
.TP
\fB\-\-camera\-index\fR <index>
Select the camera to use
.TP
\fB\-k\fR, \fB\-\-interaction\-trackball\fR [=<bool>(=1)]
Enable trackball interaction (default:
false)
.TP
\fB\-\-invert\-zoom\fR [=<bool>(=1)]
Invert zoom direction with right mouse
click (default: false)
.TP
\fB\-\-animation\-autoplay\fR [=<bool>(=1)]
Automatically start animation (default:
false)
.TP
\fB\-\-animation\-index\fR <index>
Select animation to show (deprecated)
(default: 0)
.TP
\fB\-\-animation\-indices\fR <index,index,index>
Select animations to show (default: 0)
.TP
\fB\-\-animation\-speed\-factor\fR <ratio>
Set animation speed factor (default: 1)
.TP
\fB\-\-animation\-time\fR <time>
Set animation time to load
.TP
\fB\-\-font\-file\fR <file_path>
Path to a FreeType compatible font file
.TP
\fB\-\-font\-scale\fR <ratio>
Scale fonts (default: 1)
.TP
\fB\-\-backdrop\-opacity\fR <value>
UI backdrop opacity (default: 0.9)
.TP
\fB\-\-command\-script\fR <file_path>
Path to a script file containing commands
to execute
.IP
Material options:
.TP
\fB\-o\fR, \fB\-\-point\-sprites\fR [=<string>(=sphere)]
Select point sprites type ("none",
"sphere", "gaussian") (default: none)
.TP
\fB\-\-point\-sprites\-type\fR <sphere|gaussian>
Point sprites type (deprecated)
.TP
\fB\-\-point\-sprites\-size\fR <size>
Point sprites sphere size (default: 10)
.TP
\fB\-\-point\-sprites\-absolute\-size\fR [=<bool>(=1)]
Do not scale point sprites size by scene
size (default: false)
.TP
\fB\-\-point\-size\fR <size>
Point size when showing vertices, model
specified by default
.TP
\fB\-\-line\-width\fR <width>
Line width when showing edges, model
specified by default
.TP
\fB\-\-backface\-type\fR <visible|hidden>
Backface type, can be visible or hidden,
model specified by default
.TP
\fB\-\-color\fR <color>
Solid color
.TP
\fB\-\-opacity\fR <opacity>
Opacity
.TP
\fB\-\-roughness\fR <roughness>
Roughness coefficient (0.0\-1.0)
.TP
\fB\-\-metallic\fR <metallic>
Metallic coefficient (0.0\-1.0)
.TP
\fB\-\-base\-ior\fR <base\-ior>
Index Of Refraction of the base layer
(1.0\-2.5)
.TP
\fB\-\-hdri\-file\fR <file path>
Path to an image file that can be used as a
light source and skybox
.TP
\fB\-f\fR, \fB\-\-hdri\-ambient\fR [=<bool>(=1)]
Enable HDRI ambient lighting (default:
false)
.TP
\fB\-j\fR, \fB\-\-hdri\-skybox\fR [=<bool>(=1)]
Enable HDRI skybox background (default:
false)
.TP
\fB\-\-texture\-matcap\fR <file path>
Path to a texture file containing a
material capture
.TP
\fB\-\-texture\-base\-color\fR <file path>
Path to a texture file that sets the color
of the object
.TP
\fB\-\-texture\-material\fR <file path>
Path to a texture file that sets the
Occlusion, Roughness and Metallic values of
the object
.TP
\fB\-\-texture\-emissive\fR <file path>
Path to a texture file that sets the
emitted light of the object
.TP
\fB\-\-textures\-transform\fR <transform2d>
3x3 matrix to transform textures
.TP
\fB\-\-emissive\-factor\fR <color>
Emissive factor. This value is multiplied
with the emissive color when an emissive
texture is present
.TP
\fB\-\-texture\-normal\fR <file path>
Path to a texture file that sets the normal
map of the object
.TP
\fB\-\-normal\-scale\fR <normalScale>
Normal scale affects the strength of the
normal deviation from the normal texture
.IP
Window options:
.TP
\fB\-\-background\-color\fR <color>
Background color (default: #333333)
.TP
\fB\-\-resolution\fR <width,height>
Window resolution (default: 1000, 600)
.TP
\fB\-\-position\fR <x,y>
Window position
.TP
\fB\-z\fR, \fB\-\-fps\fR [=<bool>(=1)]
Display rendering frame per second
(default: false)
.TP
\fB\-n\fR, \fB\-\-filename\fR [=<bool>(=1)]
Display filename (default: false)
.TP
\fB\-m\fR, \fB\-\-metadata\fR [=<bool>(=1)]
Display file metadata (default: false)
.TP
\fB\-\-hdri\-filename\fR [=<bool>(=1)]
Display hdri filename (default: false)
.TP
\fB\-u\fR, \fB\-\-blur\-background\fR [=<bool>(=1)]
Blur background (default: false)
.TP
\fB\-\-blur\-coc\fR <value>
Blur circle of confusion radius (default:
20)
.TP
\fB\-\-light\-intensity\fR <value>
Light intensity (default: 1)
.IP
Scientific visualization options:
.TP
\fB\-s\fR, \fB\-\-scalar\-coloring\fR [=<bool>(=1)]
Color by a scalar array (default: false)
.TP
\fB\-\-coloring\-array\fR <array_name>
Name of the array to color with
.TP
\fB\-y\fR, \fB\-\-coloring\-component\fR [=<comp_index>(=\-2)]
Component from the array to color with. \fB\-1\fR
means magnitude, \fB\-2\fR or the short option,
\fB\-y\fR, means direct scalars (default: \fB\-1\fR)
.TP
\fB\-c\fR, \fB\-\-coloring\-by\-cells\fR [=<bool>(=1)]
Use an array from the cells (default:
false)
.TP
\fB\-\-coloring\-range\fR <min,max>
Custom range for the coloring by array,
automatically computed by default
.TP
\fB\-b\fR, \fB\-\-coloring\-scalar\-bar\fR [=<bool>(=1)]
Show scalar bar (default: false)
.TP
\fB\-\-colormap\-file\fR <filePath/filename/fileStem>
Specify a colormap image
.TP
\fB\-\-colormap\-discretization\fR <int>
Specify number of colors in colormap
.TP
\fB\-\-colormap\fR <color_list>
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)
.TP
\fB\-v\fR, \fB\-\-volume\fR [=<bool>(=1)]
Show volume if the file is compatible
(default: false)
.TP
\fB\-i\fR, \fB\-\-volume\-inverse\fR [=<bool>(=1)]
Inverse opacity function for volume
rendering (default: false)
.IP
Camera options:
.TP
\fB\-\-camera\-position\fR <X,Y,Z>
Camera position (overrides camera direction
and camera zoom factor if any)
.TP
\fB\-\-camera\-focal\-point\fR <X,Y,Z>
Camera focal point
.TP
\fB\-\-camera\-view\-up\fR <direction>
Camera view up
.TP
\fB\-\-camera\-view\-angle\fR <angle>
Camera view angle (non\-zero, in degrees)
(default: 0.0)
.TP
\fB\-\-camera\-direction\fR <direction>
Camera direction
.TP
\fB\-\-camera\-zoom\-factor\fR <factor>
Camera zoom factor (non\-zero) (default:
0.0)
.TP
\fB\-\-camera\-azimuth\-angle\fR <angle>
Camera azimuth angle (in degrees),
performed after other camera options
(default: 0.0)
.TP
\fB\-\-camera\-elevation\-angle\fR <angle>
Camera elevation angle (in degrees),
performed after other camera options
(default: 0.0)
.TP
\fB\-\-camera\-orthographic\fR [=<bool>(=1)]
Use an orthographic camera
.IP
Raytracing options:
.TP
\fB\-r\fR, \fB\-\-raytracing\fR [=<bool>(=1)]
Enable raytracing (default: false)
.TP
\fB\-\-raytracing\-samples\fR <samples>
Number of samples per pixel (default: 5)
.TP
\fB\-d\fR, \fB\-\-raytracing\-denoise\fR [=<bool>(=1)]
Denoise the image (default: false)
.IP
PostFX (OpenGL) options:
.TP
\fB\-p\fR, \fB\-\-blending\fR [=<string>(=ddp)]
Select translucency blending mode ("none",
"ddp", "sort" or "stochastic") (default:
none)
.TP
\fB\-\-translucency\-support\fR [=<bool>(=1)]
Enable translucency blending (deprecated)
(default: false)
.TP
\fB\-q\fR, \fB\-\-ambient\-occlusion\fR [=<bool>(=1)]
Enable ambient occlusion providing
approximate shadows for better depth
perception, implemented using SSAO
(default: false)
.TP
\fB\-a\fR, \fB\-\-anti\-aliasing\fR [=<string>(=fxaa)]
Select anti\-aliasing method ("none",
"fxaa", "ssaa" or "taa") (default: none)
.TP
\fB\-\-anti\-aliasing\-mode\fR [=<string>(=fxaa)]
Select anti\-aliasing method ("fxaa", "ssaa"
or "taa") (deprecated)
.TP
\fB\-t\fR, \fB\-\-tone\-mapping\fR [=<bool>(=1)]
Enable Tone Mapping, providing balanced
coloring (default: false)
.TP
\fB\-\-final\-shader\fR <GLSL code>
Execute the final shader at the end of the
rendering pipeline
.IP
Testing options:
.TP
\fB\-\-reference\fR <png file>
Reference
.TP
\fB\-\-reference\-threshold\fR <threshold>
Testing threshold (default: 0.04)
.TP
\fB\-\-interaction\-test\-record\fR <file_path>
Path to an interaction log file to record
interactions events to
.TP
\fB\-\-interaction\-test\-play\fR <file_path>
Path to an interaction log file to play
interaction events from when loading a file
.SH EXAMPLES
.TP
f3d file.vtu \-xtgans
View a unstructured mesh in a typical nice looking sciviz style
.TP
f3d file.glb \-tuqap \-\-hdri\-file=file.hdr \-\-hdri\-ambient \-\-hdri\-skybox
View a gltf file in a realistic environment
.TP
f3d file.ply \-so \-\-point\-size=0 \-\-coloring\-component=\-2
View a point cloud file with direct scalars rendering
.TP
f3d folder
View all files in folder
.SH "REPORTING BUGS"
Report bugs to https://github.com/f3d\-app/f3d/issues
.PP
.br
F3D \- A fast and minimalist 3D viewer
.br
Version: 3.4.1.
.br
Build date: 2026\-01\-08 07:44:08.
.br
Build system: Linux 64\-bits.
.br
Compiler: GNU 15.2.1.
.br
Module ImGui: ON.
.br
Module OpenEXR: ON.
.br
Module Raytracing: ON.
.br
Module WebP: OFF.
.br
VTK version: 9.5.2.
.br
Copyright \(co 2019\-2021 Kitware SAS.
.br
Copyright \(co 2021\-2025 Michael Migliore, Mathieu Westphal.
.br
Copyright \(co 2025 F3D\-APP Foundation.
.br
License BSD\-3\-Clause.