Command Line Interface

Note

The command line interface is only available in the Gestaltor Professional version.

Options

-i, --input - Specify the path to a glTF or glb file to open with Gestaltor or to create a rendering of.

-o, --output - Specify an output path for the rendered image(s). Control the file type by appending .png or .jpeg to the filename.

-x, --width and -y, --height - Specify a resolution for the rendered image(s). These options will implicitly set the aspect ratio of the resulting image(s). If you are using a glTF camera with a defined aspect ratio for the rendering process, you might want to only specify height or width of the rendering. In this case, the other property will be deducted from the aspect ratio of the camera.

-c, --camera (optional) - Specify the index of a glTF camera. If this camera has an aspect ratio, only width or height of the resolution need to be specified.

-s, --scene (optional) - Specify the index of a glTF scene. If not specified, the default scene or, if not available, the first scene in the glTF will be used.

--clearcolor (optional) - Specify a color value in the format #RRGGBB (red, green, blue) or #AARRGGBB (alpha, red, green, blue) that is used as the background color. If not specified, the default environment map of the Gestaltor will be used as background.

--alphaChannel (optional) - Set this option to include the alpha channel in the rendered image(s).

--ibl (optional) - Specify a path to an .hdr file used for image-based lighting (ibl) and as a background. Use --clearcolor to overwrite this background image.

-t, --tonemapping (optional) - Add a tone mapping to the rendered image(s) by specifying the desired algorithm via its index. None = 0, ACES Filmic (NARKOWICZ) = 1, ACES Filmic (HILL) = 2, ACES Filmic (HILL - Exposure Boost) = 3.

-a, --animations (optional) - Choose which animation clips to render by specifying their indices in this format: 0,3,4 or 2 or 2

-f, --frames (optional) - Specify the number of animated frames that should be rendered. Each frame will produce one output image.

-r, --framerate (optional) - Specify the framerate frames per second that is used when rendering multiple frames of animation. The default is 60 frames per second.

--radius (optional) - Specify the distance from the camera to the target. This option is used for orbit camera configuration and is ignored when a glTF camera is specified with -c, --camera.

--target (optional) - Specify the target in world coordinates that the camera looks at in this format: 0.0,0.0,0.0. This option is used for orbit camera configuration and is ignored when a glTF camera is specified with -c, --camera.

--theta (optional) - Specify the horizontal camera angle degrees. 90 degrees looks along the -X axis. This option is used for orbit camera configuration and is ignored when a glTF camera is specified with -c, --camera.

--phi (optional) - Specify the vertical camera angle degrees. 90 degrees looks along the -Y axis. This option is used for orbit camera configuration and is ignored when a glTF camera is specified with -c, --camera.

--yfov (optional) - Specify the vertical field of view degrees. Using this option forces perspective projection.

-?, -h, --help - Display help on command line options.

--help-all - Displays help including Qt specific options.

-v, --version - Displays version information.