RealityServer Configuration

Rendering Directives

The following directives configure rendering.

resources

Description Directory to find textures
Syntax resources directory
Context global
Default none

A directory path that is used to find rendering resources (normally, texture image files and IES light profiles). There can be more than one resources key; the specified paths are searched in sequence. It is not an error if the specified directory does not exist.

include_path

Description Directory to find include files
Syntax include_path directory
Context global
Default none

A directory path that is used to find files included in a scene file with $include statements. There can be more than one include key; the specified paths are searched in sequence. It is not an error if the specified directory does not exist.

iray_render_mode

Description Controls whether CPU, GPU or both should be used for iray rendering.
Syntax iray_render_mode mode
Context global
Default mixed

Controlling the way iray spreads its work across the available resources. This option has the following possible values:

mixed
All available resources are used. Work is dynamically balanced between the resources to ensure that the time each of the resources needs is the same for all. Thus this has the potential of giving the highest performance when different GPUs are used in one machine. Please note, that if clustered rendering is used this mode is not available. This is the default mode if networking is not enabled.
cuda_dynamic
Only the CUDA capable GPUs are used. Load is dynamically rebalanced between GPUs. Please note, that if clustered rendering is used this mode is not available.
cuda_static
This option is no longer supported. Selecting it will instead use cuda_dynamic.
cpu
Only the available CPU cores are used. iray will balance the work to make optimal use of all available CPU cores.

cpu_fallback_enabled

Description Whether to fallback to CPU rendering on GPU failure.
Syntax cpu_fallback_enabled on|off
Context global
Default on

If set to "on" then when rendering fails for some reason on the GPU, RealityServer will attempt to use the CPU for rendering instead. If "off" then a failure to render with GPU resources will result in the render request failing entirely.

cpu_load_limit

Description Sets the CPU percentage usage for rendering.
Syntax cpu_load_limit 0-100
Context global
Default 100

This value limits the CPU usage for rendering. Where a value of 0 disables CPU rendering and a value of 100 will fully utilise the CPU. A value of 0 here will override disabling CPU rendering regardless of other configuration values.

gpu_load_limit

Description Sets the GPU percentage usage for rendering.
Syntax gpu_load_limit 0-100
Context global
Default 100

This value limits the GPU usage for rendering. Where a value of 0 disables GPU rendering and a value of 100 will fully utilise all GPUs available. A value of 0 here will override disabling GPU rendering regardless of other configuration values.

attribute_filter

Description Adds custom attribute filter
Syntax attribute_filter filter
Context global
Default none

Custom attribute filters are used to prevent non-predefined attributes on scene elements from causing the render to update when they are created/changed or removed. Only non-predefined attributes will be considered. The filter value itself is an extended regular expression that acts as filter on the names of attributes. The regular expression is matched to any part of the attribute name, not just to the entire attribute name. There can be more than one attribute_filter statement.