.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH VDB_RENDER "1" "February 2024" "vdb_render 10.0.1" "User Commands"
.SH NAME
vdb_render - ray-traces OpenVDB volumes
.SH SYNOPSIS
.B vdb_render
\fI\,in.vdb out.{ppm,exr,png} \/\fR[\fI\,options\/\fR]
.SH DESCRIPTION
Which: ray\-traces OpenVDB volumes
Options:
.TP
\fB\-aperture\fR F
perspective camera aperture in mm (default: 41.2)
.TP
\fB\-camera\fR S
camera type; either "persp[ective]" or "ortho[graphic]"
(default: perspective)
.TP
\fB\-compression\fR S
EXR compression scheme; either "none" (uncompressed),
"rle" or "zip" (default: zip)
.TP
\fB\-cpus\fR N
number of rendering threads, or 1 to disable threading,
or 0 to use all available CPUs (default: 0)
.TP
\fB\-far\fR F
camera far plane depth (default: 3.4e+38)
.TP
\fB\-focal\fR F
perspective camera focal length in mm (default: 50)
.TP
\fB\-fov\fR F
perspective camera field of view in degrees
(default: 44.8)
.TP
\fB\-frame\fR F
ortho camera frame width in world units (default: 1)
.TP
\fB\-lookat\fR X,Y,Z
rotate the camera to point to (X, Y, Z)
.TP
\fB\-name\fR S
name of the volume to be rendered (default: render
the first floating\-point volume found in in.vdb)
.TP
\fB\-near\fR F
camera near plane depth (default: 0.001)
.TP
\fB\-res\fR WxH
image dimensions in pixels (default: 1920x1080)
.HP
\fB\-r\fR X,Y,Z
.TP
\fB\-rotate\fR X,Y,Z
camera rotation in degrees
(default: look at the center of the volume)
.HP
\fB\-t\fR X,Y,Z
.TP
\fB\-translate\fR X,Y,Z
camera translation
.TP
\fB\-up\fR X,Y,Z
vector that should point up after rotation with \fB\-lookat\fR
(default: [0, 1, 0])
.TP
\fB\-v\fR
verbose (print timing and diagnostics)
.TP
\fB\-version\fR
print version information and exit
.TP
\fB\-h\fR, \fB\-help\fR
print this usage message and exit
.SS "Level set options:"
.TP
\fB\-color\fR S
name of a vec3s volume to be used to set material colors
.TP
\fB\-isovalue\fR F
isovalue in world units for level set ray intersection
(default: 0)
.TP
\fB\-samples\fR N
number of samples (rays) per pixel (default: 1)
.TP
\fB\-shader\fR S
shader name; either "diffuse", "matte", "normal"
or "position" (default: diffuse)
.SS "Dense volume options:"
.TP
\fB\-absorb\fR R,G,B
absorption coefficients (default: [0.1, 0.1, 0.1])
.TP
\fB\-cutoff\fR F
density and transmittance cutoff value (default: 0.005)
.TP
\fB\-gain\fR F
amount of scatter along the shadow ray (default: 0.2)
.TP
\fB\-light\fR X,Y,Z[,R,G,B]
light source direction and optional color
(default: [0.3, 0.3, 0, 0.7, 0.7, 0.7])
.TP
\fB\-scatter\fR R,G,B
scattering coefficients (default: [1.5, 1.5, 1.5])
.TP
\fB\-shadowstep\fR F
step size in voxels for integration along the shadow ray
(default: 3)
.TP
\fB\-step\fR F
step size in voxels for integration along the primary ray
(default: 1)
.SH EXAMPLES
.IP
vdb_render crawler.vdb crawler.{ppm,exr,png} \-shader diffuse \-res 1920x1080 \e
.HP
\-focal 35 \-samples 4 \-translate 0,210.5,400 \-compression rle \-v
.IP
vdb_render bunny_cloud.vdb bunny_cloud.{ppm,exr,png} \-res 1920x1080 \e
.HP
\-translate 0,0,110 \-absorb 0.4,0.2,0.1 \-gain 0.2 \-v
.SS "Warning:"
.IP
This is not (and is not intended to be) a production\-quality renderer.
Use it for fast previewing or simply as a reference implementation
for integration into existing ray tracers.
.SH AUTHOR
This manual page was written by Mathieu Malaterre <malat@debian.org> for the
Debian GNU/Linux system (but may be used by others).