.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH F3D "1" "November 2022" "f3d 1.3.1" "User Commands"
.SH NAME
f3d \- F3D - Fast and minimalist 3D viewer
.SH DESCRIPTION
F3D \- A fast and minimalist 3D viewer
Usage:
.IP
f3d [OPTION...] file1 file2 ...
.IP
Applicative options:
.TP
\fB\-\-output\fR <png file>
Render to file
.TP
\fB\-\-no\-background\fR
No background when render to file
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help
.TP
\fB\-\-version\fR
Print version details
.TP
\fB\-\-readers\-list\fR
Print the list of file types
.TP
\fB\-\-config\fR <file path>
Read a provided configuration file instead of
default one
.TP
\fB\-\-dry\-run\fR
Do not read the configuration file
.TP
\fB\-\-no\-render\fR
Verbose mode without any rendering, only for
the first file
.IP
Camera options:
.TP
\fB\-\-camera\-position\fR <X,Y,Z>
Camera position
.TP
\fB\-\-camera\-focal\-point\fR <X,Y,Z>
Camera focal point
.TP
\fB\-\-camera\-view\-up\fR <X,Y,Z>
Camera view up
.TP
\fB\-\-camera\-view\-angle\fR <angle>
Camera view angle (non\-zero, in degrees)
.TP
\fB\-\-camera\-azimuth\-angle\fR <angle>
Camera azimuth angle (in degrees) (default:
0)
.TP
\fB\-\-camera\-elevation\-angle\fR <angle>
Camera elevation angle (in degrees)
(default: 0)
.IP
General options:
.TP
\fB\-\-verbose\fR
Enable verbose mode, providing more
information about the loaded data in the
console output
.TP
\fB\-\-quiet\fR
Enable quiet mode, which superseed any
verbose options and prevent any console
output to be generated at all
.TP
\fB\-\-progress\fR
Show progress bar
.TP
\fB\-\-geometry\-only\fR
Do not read materials, cameras and lights
from file
.TP
\fB\-\-up\fR [\-X|+X|\-Y|+Y|\-Z|+Z]
Up direction (default: +Y)
.TP
\fB\-x\fR, \fB\-\-axis\fR
Show axes
.TP
\fB\-g\fR, \fB\-\-grid\fR
Show grid
.TP
\fB\-e\fR, \fB\-\-edges\fR
Show cell edges
.TP
\fB\-\-camera\-index\fR <index>
Select the camera to use (default: \fB\-1\fR)
.TP
\fB\-k\fR, \fB\-\-trackball\fR
Enable trackball interaction
.TP
\fB\-\-animation\-index\fR <index>
Select animation to show (default: 0)
.TP
\fB\-\-font\-file\fR <file_path>
Path to a FreeType compatible font file
.IP
Material options:
.TP
\fB\-o\fR, \fB\-\-point\-sprites\fR
Show sphere sprites instead of geometry
.TP
\fB\-\-point\-size\fR <size>
Point size when showing vertices or point
sprites (default: 10)
.TP
\fB\-\-line\-width\fR <width>
Line width when showing edges (default: 1)
.TP
\fB\-\-color\fR <R,G,B>
Solid color (default: 1,1,1)
.TP
\fB\-\-opacity\fR <opacity>
Opacity (default: 1)
.TP
\fB\-\-roughness\fR <roughness>
Roughness coefficient (0.0\-1.0) (default:
0.3)
.TP
\fB\-\-metallic\fR <metallic>
Metallic coefficient (0.0\-1.0) (default: 0)
.TP
\fB\-\-hdri\fR <file path>
Path to an image file that will be used as
a light source
.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\-\-emissive\-factor\fR <R,G,B>
Emissive factor. This value is multiplied
with the emissive color when an emissive
texture is present (default: 1,1,1)
.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
(default: 1)
.IP
PostFX (OpenGL) options:
.TP
\fB\-p\fR, \fB\-\-depth\-peeling\fR
Enable depth peeling
.TP
\fB\-q\fR, \fB\-\-ssao\fR
Enable Screen\-Space Ambient Occlusion
.TP
\fB\-a\fR, \fB\-\-fxaa\fR
Enable Fast Approximate Anti\-Aliasing
.TP
\fB\-t\fR, \fB\-\-tone\-mapping\fR
Enable Tone Mapping
.IP
Scientific visualization options:
.TP
\fB\-s\fR, \fB\-\-scalars\fR [=<array_name>(=)]
Color by scalars (default: f3d_reserved)
.TP
\fB\-y\fR, \fB\-\-comp\fR [=<comp_index>(=\-2)]
Component from the scalar 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\-\-cells\fR
Use a scalar array from the cells
.TP
\fB\-\-range\fR <min,max>
Custom range for the coloring by array
.TP
\fB\-b\fR, \fB\-\-bar\fR
Show scalar bar
.TP
\fB\-\-colormap\fR <color_list>
Specify a custom colormap (default:
0,0,0,0,0.4,0.9,0,0,0.8,0.9,0.9,0,1,1,1,1)
.TP
\fB\-v\fR, \fB\-\-volume\fR
Show volume if the file is compatible
.TP
\fB\-i\fR, \fB\-\-inverse\fR
Inverse opacity function for volume
rendering
.IP
Testing options:
.TP
\fB\-\-ref\fR <png file>
Reference
.TP
\fB\-\-ref\-threshold\fR <threshold>
Testing threshold (default: 50)
.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
.IP
Window options:
.TP
\fB\-\-bg\-color\fR <R,G,B>
Background color (default: 0.2,0.2,0.2)
.TP
\fB\-\-resolution\fR <width,height>
Window resolution (default: 1000,600)
.TP
\fB\-z\fR, \fB\-\-fps\fR
Display frame per second
.TP
\fB\-n\fR, \fB\-\-filename\fR
Display filename
.TP
\fB\-m\fR, \fB\-\-metadata\fR
Display file metadata
.TP
\fB\-f\fR, \fB\-\-fullscreen\fR
Full screen
.TP
\fB\-u\fR, \fB\-\-blur\-background\fR
Blur background
.SS "Keys:"
.TP
C
Cycle point/cell data coloring
.TP
S
Cycle array to color with
.TP
Y
Cycle array component to color with
.TP
B
Toggle the scalar bar display
.TP
V
Toggle volume rendering
.TP
I
Toggle inverse volume opacity
.TP
O
Toggle point sprites rendering
.TP
P
Toggle depth peeling
.TP
Q
Toggle SSAO
.TP
A
Toggle FXAA
.TP
T
Toggle tone mapping
.TP
E
Toggle the edges display
.TP
X
Toggle the axes display
.TP
G
Toggle the grid display
.TP
N
Toggle the filename display
.TP
M
Toggle the metadata display
.TP
Z
Toggle the FPS counter display
.TP
R
Toggle raytracing rendering
.TP
D
Toggle denoising when raytracing
.TP
F
Toggle full screen
.TP
U
Toggle blur background
.TP
K
Toggle trackball interaction
.TP
H
Toggle cheat sheet display
.TP
?
Dump camera state to the terminal
.TP
Escape
Quit
.TP
Enter
Reset camera to initial parameters
.TP
Space
Play animation if any
.TP
Left
Previous file
.TP
Right
Next file
.TP
Up
Reload current 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.hdr
View a gltf file in a realistic environment
.TP
f3d file.ply \-so \-\-point\-size=0 \-\-comp=\-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: 1.3.1.
.br
Build date: 2022\-11\-06 13:17:51.
.br
Build system: Linux.
.br
Compiler: GNU 12.2.0.
.br
External rendering module: OFF.
.br
Raytracing module: OFF.
.br
Exodus module: ON.
.br
OpenCASCADE module: 7.6.3 (full support).
.br
Assimp module: 5.2.4.
.br
Alembic module: OFF.
.br
VTK version: 9.1.0 (build 0).
.br
Copyright \(co 2019\-2021 Kitware SAS.
.br
Copyright \(co 2021\-2022 Michael Migliore, Mathieu Westphal.
.br
License BSD\-3\-Clause.
.br
By Michael Migliore, Mathieu Westphal and Joachim Pouderoux.