Rendering options

This section describes the options to be used with the IRender_context class as provided by Iray Blend.

Iray Blend can use two render modes for rendering. It can also blend between the images generated by those two render modes. The selection of the render modes, the blend settings, and the options used by the actually used render modes are done using the following render context options:

const char* preview_render_mode = ""

This specifies the render mode to be used during the preview phase of the rendering. Changing this value also clears all options forwarded to the preview render mode.

const char* refined_render_mode = ""

This specifies the render mode to be used during the refinement phase of the rendering. Changing this value also clears all options forwarded to the refined render mode.

const char* preview_options = ""

This specifies the options to be used during the preview phase of the rendering. If nothing is given here, the normal scene options will be used.

const char* refined_options = ""

This specifies the options to be used during the refinement phase of the rendering. If nothing is given here, the normal scene options will be used.

mi::Uint32 preview_frames = 2

The number of frames which are rendered using only the preview render mode. After that many frames, the refined render mode do the rendering instead, although the results may be visible to the user only later.

mi::Uint32 start_blending_frame = 5

The number of frames after which blending between the render modes starts. Note that this must be greater or equal to the preview_frames option. If it is greater, then the refined render mode will render already, but the image from that rendering will not be shown, yet. This can be used to avoid getting a lot of noise for the initial blend frames, when the refined render mode is for example the Photoreal render mode.

mi::Uint32 blending_frames = 5

The number of frames over which Iray Blend blends from the preview render mode to the refined render mode.

mi::Float32 blending_exponent = 1.0

The exponent of the blending function, i.e., 1 = linear blending, 2 = quadratic, etc.

To set render context options for the preview or refined render mode, prefix the option name with "preview_" or "refined_", respectively. Note that error reporting for render context options forwarded in this way is limited. The set of render context options forwarded to the preview or refined rende mode will be cleared when the value of the render context options preview_render_mode or refined_render_mode is changed, respectively. The render context methods get_options_length(), get_option_name(), and get_option_type() do not take forwarded options into account.