Image Display: imf

Image Display: imf_disp

The image display and playback utility for mental ray. This page describes version 2.0, a major upgrade with added support for multi-layer and multi-channel image files as well as stereoscopic display, viewing of HDR images with exposure control, and more. By default, the tool uses OpenGL to leverage the GPU for fast view manipulations and display performance. The description of the previous version 1.x can be found here.

Usage

The image display utility is started as

imf_disp [options] [file ...]

The application comes with a graphical user interface (GUI) with identical look and feel on all supported platforms. All actions like file loading, display manipulations, and playback control are exposed in this GUI. However, the executable may be started in a command shell, where the command line options and file parameters can be used to initialize the viewer with certain settings and content. If a single file is given then it will be opened and displayed as an image if supported. If multiple files are given they can be played back as an animation sequence. If stereo mode is enabled then every two files are considered as left and right eye images of the same render.

If the file to display is currently being rendered, imf_disp will try to establish a display connection to the mental ray process that is rendering it, and show the rendering progress simultaneously. This works even if mental ray and imf_disp run on different machines in a network. Files that are still being rendered can be recognized by their size, which is always 128 bytes. Only one imf_disp at a time can be connected to a running mental ray.

Options

The following options are supported:

-c name --channel=name: Display the channel with the given name, if existing.
Standard channel names are: c (for rgb color), r, g, b, a, and z.; Default: c.
--cache-all-layers
-e <float> --exposure <float>: Set exposure to the given floating-point value.
The typical range of values is [0.1 ... 10.0].; Default: 1.0.
--frame
--frame-rate
--disable-gl: Disable OpenGL for display.
This will disable some of the features like zoom and pan, but may reduce load on the GPU.; Default: enable OpenGL.
-g <float> --gamma=<float>: Set gamma correction to the given floating-point value.
The typical range of values is [1.0 ... 3.0].; Default: 1.0, which disables gamma handling.
-h --help: Display brief help text in a window.
--height=<int>: Set height of the window on screen, in pixels.; Default: system default.
-l name --layer=name: Display the image layer with the given name, if existing.; Default: first layer.
--live-update: If enabled the viewer will watch the displayed file. If it is currently being rendered imf_disp will connect to the mental ray process and show the image progress live. If disabled, the displayed image will stay on the display even if re-rendered. In addition, if the image has been touched by means other than re-rendering then it will also be re-loaded.; Default: on.
--on-image-load
--playback-controls=<bool>: Toggle display of the playback controls.; Default: user preferences.
-s --stereo-display: Enable stereo display.
With this option, every two files on the command line are expected to represent left and right eye images.; Default: disabled.
-t --tone-map: Enable tone mapping.; Default: disabled.
--view-controls: Toggle display of the view controls.; Default: user preferences.
--width=<int>: Set width of the window on screen, in pixels.; Default: system default.
-x <int> --x_pos=<int>: Set horizontal position of the window on screen, in pixels.; Default: system default.
--y <int> --y_pos=<int>: Set vertical position of the window on screen, in pixels.; Default: system default.