width
Sets the width (horizontal resolution) of the output image.
type: integer
restrictions: must be > 0
units: pixels
default value: 600
height
Sets the height (vertical resolution) of the output image.
type: integer
restrictions: must be > 0
units: pixels
default value: 450
metropolis
Enables or disables Metropolis-Hastings sampling
type: boolean
default value: true
large_mutation_prob
Probability of selecting a large mutation type. Only used if metropolis is true.
type: scalar real
restrictions: must in range [0, 1]
units: dimensionless
default value: 0.4
max_change
Radius of the perturbation mutation distribution.
type: scalar real
restrictions: must in range [0, 1]
units: dimensionless
default value: 0.01
max_depth
Maximum ray bounce depth.
type: integer
restrictions: must be > 0
units: number of bounces
default value: 10000
gpu_max_depth
Maximum ray bounce depth for GPU rendering.
type: integer
restrictions: must be > 0
units: number of bounces
default value: 8
max_num_consec_rejections
Maximum number of consecutive rejection of tentative new samples when Metropolis-Hastings transport is used. Note that any non-infinite number technically causes biased sampling.
type: integer
restrictions: must be > 0
units: number of rejections
default value: 1000
logging
If true, a log of the console output is written to log.txt
type: boolean
default value: true
bidirectional
If true, bidirectional path tracing is used to construct paths. Otherwise, backwards path tracing is used.
type: boolean
default value: true
save_png
If true, a tonemapped PNG image is saved in the renders directory.
type: boolean
default value: true
save_untonemapped_exr
If true, an untonemapped EXR image is saved in the renders directory.
type: boolean
default value: false
save_tonemapped_exr
If true, a tonemapped EXR image is saved in the renders directory.
type: boolean
default value: false
save_igi
If true, an untonemapped Indigo Image (.igi) file is saved in the renders directory.
type: boolean
default value: false
save_render_channels_exr
If true, light layers and render channels are saved to EXR(s) in the renders directory.
type: boolean
default value: false
image_save_period
The rendered image(s) will be saved to the renders directory every image_save_period seconds.
type: scalar real
restrictions: must be > 0
units: seconds
default value: 60
halt_time
If positive, indigo will halt after halt_time seconds.
type: scalar real
restrictions:
units: seconds
default value: -1
halt_samples_per_pixel
If positive, indigo will halt after halt_samples_per_pixel samples per pixel have been reached.
type: scalar real
restrictions:
units: samples / pixel
default value: -1
auto_choose_num_threads
If true, the number of render threads used is set based on the number of logical cores detected.
type: boolean
default value: true
num_threads
Number of render threads used. This setting is only used if auto_choose_num_threads is false.
type: integer
restrictions: must be > 0
units: number of threads
default value: 1
super_sample_factor
If this factor is greater than 1, then the image is rendered at a higher resolution internally, then downsampled using the downsize filter before the render is saved to disk. This can help to reduce aliasing around high contrast edges.
Note that higher factors require more memory (RAM).
type: integer
restrictions: must be > 0
units: dimensionless
default value: 2
watermark
If true, an 'Indigo Renderer' logo is drawn on the bottom right hand corner of the output render.
type: boolean
default value: false
info_overlay
If true, a line of text is drawn on the bottom of each render, containing some statistics about the current render process.
type: boolean
default value: false
verbose
If true, prints extra information during the scene build process to the render log widget and to the render log on disk.
type: boolean
default value: false
aperture_diffraction
If true, diffraction of light passing through the camera aperture is simulated.
type: boolean
default value: false
post_process_diffraction
If true, aperture_diffraction is simulated using a filter applied to the image buffer, instead of perturbation of rays. This technique is generally faster and less noisy, but slightly less accurate.
type: boolean
default value: true
write_aperture_preview
If true, saves a preview image of the camera aperture to disk when rendering starts.
type: boolean
default value: false
wait_for_slave_frames_on_stop
If true, waits for network slaves to upload the current image frame they are working on before stopping the rendering process.
type: boolean
default value: false
close_gui_on_halt
If true, closes the user interface after the halt condition is reached.
type: boolean
default value: false
save_images_on_close
If true, saves the current rendering to disk when the scene is closed.
type: boolean
default value: false
render_region
If this element is present, only a certain region of the usual image is rendered.
Only pixels (x, y) such that x1 <= x < x2 and y1 <= y < y2 are rendered.
render_region::x1
X Coordinate of top left pixel of rendered region.
type: integer
restrictions: must be >= 0
units: pixels
render_region::y1
Y Coordinate of top left pixel of rendered region.
type: integer
restrictions: must be >= 0
units: pixels
render_region::x2
X Coordinate of pixel immediately to the right of rendered region.
type: integer
restrictions: x1 < x2 <= width
units: pixels
render_region::y2
Y Coordinate of pixel immediately below rendered region.
type: integer
restrictions: y1 < y2 <= height
units: pixels
render_foreground_alpha
If this is true, renders an alpha channel as well as the usual RGB channels, where the foreground is alpha one, and the background (physical sky, env map, constant background, void background etc..) is alpha zero.
type: boolean
default value: false
shadow_pass
If true, renders a shadow pass. This captures the fraction of light unshadowed at each point on a shadow receiver material.
type: boolean
default value: false
splat_filter
Controls the filter used for splatting contributions to the image buffer.
Can be one of fastbox, radial, or mn_cubic.
splat_filter::fastbox
Default box filter, produces acceptable image quality and is very fast.
splat_filter::radial
A radially symmetric filter, slightly blurrier than fastbox and therefore should be used with super_sample_factor greater than one.
splat_filter::mn_cubic
Mitchell-Netravali cubic filter. Good all-round filter with little aliasing, but can cause black edges around high contrast edges (especially noticeable in HDR images).
Please refer to the paper 'Reconstruction Filters in Computer Graphics' by Mitchell and Netravali, 1988, for more information.
splat_filter::mn_cubic::blur
The 'B' parameter from the paper. Higher blur values cause more blurring of the image.
type: scalar real
restrictions: will give best results in range [0, 1]
units: dimensionless
default value: 0.6
splat_filter::mn_cubic::ring
The 'C' parameter from the paper. Higher ring values cause more 'ringing' (alternating bands of black and white around high contrast edges).
Note that Mitchell and Netravali recommend choosing B and C such that 2C + B = 1.
type: scalar real
restrictions: will give best results in range [0, 1]
units: dimensionless
default value: 0.2
downsize_filter
Controls the filter used for downsizing super-sampled images.
Only used when super_sample_factor is greater than one.
Can be one of mn_cubic (with the same parameters as the splat filter), gaussian (good for HDR images where you want to avoid black edges) or sharp.
downsize_filter::mn_cubic::radius
Defines the radius of the downsize filter function. Unlike the splat_filter, the downsize_filter can override the default mn_cubic filter radius of 2.0. This is only suggested for the B = 1, C = 0 case, where the radius can be set to a lower value such as 1.6 to prevent excessive blurring.
type: scalar real
restrictions: must be > 0.0.
units: dimensionless
default value: 2.0
element status: optional
vignetting
Toggles camera vignetting on/off.
type: boolean
default value: true
merging
If true, merges some objects together in order to improve the rendering speed.
type: boolean
default value: true
dithering
If true, adds some quasi-random noise to the render to avoid banding artifacts in the saved low-dynamic-range images.
type: boolean
default value: true
zero_alpha_outside_region
If true, when doing region rendering, parts of the image outside the render region have their alpha values set to zero. (e.g. they become invisible).
type: boolean
default value: false
gpu
Toggles GPU acceleration on/off.
type: boolean
default value: false
allow_high_quality_bvh
If true, a high-quality BVH build is done after GPU/Open-CL rendering begins, and is then subsequently used for GPU rendering. Requires more memory but results in faster rendering.
type: boolean
default value: true
clamp_contributions
If true, high contribution splats are clamped, resulting in fewer fireflies.
Introduces some bias to the rendering process.
type: boolean
default value: false
max_contribution
Contributions with components above this value will be clamped to this value, if clamp_contributions is enabled.
type: real
default value: 10.0
layer_setting
The layer_setting element allows setting some details about a specific light layer.
layer_setting::name
Sets the name of the light layer.
type: string
layer_setting::enabled
Enables or disabled the layer.
type: boolean
required: optional
default value: true
layer_setting::layer_scale
The layer_scale element controls scaling of the colour values in the light layer.
layer_setting::layer_scale::blackbody::temperature
Sets the colour temperature.
type: real
layer_setting::layer_scale::blackbody::gain
Sets a multiplier for the blackbody spectrum.
type: real
layer_setting::layer_scale::rgb::rgb
Sets the rgb colour
type: 3-vector
layer_setting::layer_scale::rgb::gain
Sets a multiplier for the RGB colour.
type: real
layer_setting::layer_scale::xyz::xyz
Sets the XYZ colour
type: 3-vector
layer_setting::layer_scale::xyz::gain
Sets a multiplier for the XYZ colour.
type: real
Render channels
These settings are all boolean, with default values false.
Please see the render channels section in the Indigo manual for more details on each channel.
normals_channel
normals_pre_bump_channel
position_channel
depth_channel
material_id_channel
object_id_channel
foreground_channel
material_masks
object_masks
direct_lighting_channel
indirect_lighting_channel
specular_reflection_lighting_channel
refraction_lighting_channel
transmission_lighting_channel
emission_lighting_channel
participating_media_lighting_channel
sss_lighting_channel
main_beauty_channel
This is the channel that is usually rendered, consisting of the main beauty render (possibly with multiple layers).
This channel can be disabled, for example if you just want to quickly render the normals channel.
default value: true
trace_through_trans_mats_for_channels
If true, rays are traced through transparent materials such as specular, when rendering albedo and normal passes.
If false, transparent materials are treated as opaque, so the albedo and normals will be those of the transparent materials themselves.
default value: true
spectral_output
If enabled, rendering is done to a spectral internal buffer, in addition to the usual XYZ colour-space buffer.
The spectral render channel will be available for viewing in the Indigo UI, and can be saved to disk.
type: boolean
default value: false
spectral_output_num_wavelength_buckets
Number of wavelength buckets used for the internal spectral render buffer.
type: integer
restrictions: >= 1
default value: 8
spectral_output_start_wavelength
This is the start wavelength (wavelength at the lower edge of the bucket) for the lowest-wavelength bucket, for the internal spectral render buffer. This value can be set to lower than 390 nm, although currently no lighting calculations for wavelengths lower than 390 nm will be computed.
type: real
unit: nm
restrictions: > 0
default value: 390
spectral_output_bucket_width
The width, in nm, of the wavelength buckets for the internal spectral render buffer.
type: real
unit: nm
restrictions: > 0
default value: 38.75
light_map_baking_ob_uid
If set to a valid UID (>= 0), Indigo will compute a lightmap for the object with the given UID.
type: int
default value: -1
generate_lightmap_uvs
If set to true, Indigo will generate a UV mapping for the mesh that it is computing lightmaps for, if any (see light_map_baking_ob_uid). The new UV mapping will be added to the mesh after the existing UV mappings.
For example, if the mesh has a single UV mapping with index 0, then a new UV mapping will be created with index 1.
The modified mesh with the additional UV mapping will be saved to disk at 'mesh_with_lightmap_uvs.igmesh' in the Indigo Renderer application data dir. (e.g. C:\Users\xx\AppData\Roaming\Indigo Renderer)
If generate_lightmap_uvs is false, then the UV mapping with the highest index in the mesh will be used as the lightmap UV mapping.
type: boolean
default value: false
capture_direct_sun_illum
This option only has an effect when computing a lightmap.
If set to false, direct illumination from the sun will not be captured in the light map. This is useful in the case that direct sun illumination will be rendered using some other technique at runtime, for example shadow mapping.
type: boolean
default value: true