iray_Renderer : RendererClass

iray_Renderer - superclass: RendererClass; super-superclass:MAXWrapper - 29:29 - classID: #(1048411834, 348141227)

Lighting And Rendering - Quick Navigation

The iray renderer is a unbiased path tracer designed to perform physically accurate lighting simulations using both the CPU and any available GPUs on the host system.

For advanced settings, see also the iray String Options topic.

Available in 3ds Max 2012 and higher.

Constructor:

iray_Renderer ...
mental_ray_iray_Renderer ...

EXAMPLE

--Assign an iRay renderer class instance
--to the current renderer:
renderers.current = iRay_Renderer ()
--> iRay_Renderer:iRay_Renderer

Properties:

iRay Rollout

"Rendering Duration Per Frame" Group Of Controls

<iray_Renderer>.durationInSeconds Integer default: 60 -- integer

Get/set the time in seconds to run the simulation.

Valid value range is 1 to 1073741824, default is 60 seconds.

<iray_Renderer>.durationMode Name default: #time -- enum

durationMode enums: {#time|#iterations|#unlimited}

Get/set the state of the Duration Mode radio buttons.

When set to #time (default), the simulation will stop after the number of seconds specified by the .durationInSeconds property.

When set to #iterations , the simulation will perform the number of iterations specified by the .durationPasses property.

When set to #unlimited , the simulation will continue until stopped manually.

<iray_Renderer>.durationPasses Integer default: 500 -- integer

Get/set the number of passes to iterate through when the .durationMode is set to #iterations

Valid value range is 1 to 1073741824, default is 500 iterations.

Advanced Parameters Rollout

<iray_Renderer>.textureCompressionEnabled     BooleanClass    default: false   --  boolean

Get/set the state of the "Texture Compression" > "Enable" checkbox.

<iray_Renderer>.textureCompressionMinResolution     Integer    default: 128   --  integer

Get/set the value of the "Texture Compression" > "Disable compression below ... pixels" spinner.

Valid range is between 0 and 32768.

When set to 0, all textures will be compressed.

When set to 128 (default), textures above 128 pixels resolution will be compressed.

When set to 32768, no texture compression will be performed.

Solver Methods

<iray_Renderer>.architecturalSamplerEnabled     BooleanClass    default: false   --  boolean

Get/set the state of the "Architectural Sampler" checkbox.

Available in 3ds Max 2014 and higher.

<iray_Renderer>.causticSamplerEnabled     BooleanClass    default: false   --  boolean

Get/set the state of the "Caustic Sampler" checkbox.

Available in 3ds Max 2014 and higher.

"Trace/Bounce Limits" Group Of Controls

<iray_Renderer>.lightBouncesLimited BooleanClass default: false -- boolean

Get/set the state of the radio buttons controlling the Trace/Bounce Limits.

When set to False (default), the light bounces will not be limited, producing a physically accurate lighting simulation.

When set to True, the light bounces will be limited to the threshold defined by the .lightBouncesMaximum property.

<iray_Renderer>.lightBouncesMaximum Integer default: 4 -- integer

Get/set the maximum number of light bounces used when the .lightBouncesLimited property is set to True.

Valid value range is 2 to 1073741824, default is 4.

"Image Filtering (Antialiasing)" Group Of Controls

<iray_Renderer>.imageFilterType Name default: #gauss -- enum

imageFilterType enums: {#box|#gauss|#triangle}

Get/set the image filter type.

<iray_Renderer>.imageFilterWidth Float default: 3.0 -- float

Get/set the image filter width.

Valid value range is 0.0 to 8.0, default is 3.0.

"Material Override" Group Of Controls

<iray_Renderer>.overrideMaterialEnabled BooleanClass default: false -- boolean

Get/set the state of the Material Override > Enable option.

When set to true, all scene materials will be overridden with the material specified by the .overrideMaterial property.

When set to false (default), the existing scene materials will be used, regardless of the value of the .overrideMaterial property.

<iray_Renderer>.overrideMaterial UndefinedClass default: undefined -- material

Displacement Parameters

<iray_Renderer>.displacementDisplaceMethod     Name    default: #length   --  enum

Get/set the state of the "Method" radio buttons.

Possible values are:

#length

#parametric

<iray_Renderer>.displacementParametricSubdivisionLevel     Integer    default: 5   --  integer

"Displacement (Global Settings)" Group Of Controls

<iray_Renderer>.displacementView BooleanClass default: true -- boolean

Get/set the state of the "View" option.

<iray_Renderer>.displacementSmoothing BooleanClass default: true -- boolean

Get/set the state of the "Smoothing" option.

<iray_Renderer>.displacementEdgeLength Float default: 2.0 -- float

Get/set the "Edge Length" property value.

Valid value range is 0.0 to 1e+006, default is 2.0

<iray_Renderer>.displacementMaximum Float default: 20.0 -- float

Get/set the "Max.Displace" property value.

Valid value range is 0.0 to 1e+006, default is 20.0

<iray_Renderer>.displacementSubdivisionLevel Integer default: 6 -- integer

Get/set the drop-down list state of the "Max.Subdiv." option.

Possible values are:

0 - 4

1 - 16

2 - 64

3 - 256

4 - 1K

5 - 4K

6 - 16K (default)

7 - 64K

Hardware Resources Rollout

<iray_Renderer>.NumberOfAllocatedCPUS     Integer    default: 8   --  integer

Get/set the number of CPUs to allocate for iRay rendering.

Accepted values are between 0 and 8.

Available in 3ds Max 2014 and higher.

For related methods, see the Interface: mental_ray_iray_options further on this page.

Motion Blur Rollout

"Motion Blur" Group Of Controls

<iray_Renderer>.motionBlurEnabled     BooleanClass    default: false   --  boolean

Get/set the state of the Motion Blur > "Enable" checkbox.

Available in 3ds Max 2013 and higher.

<iray_Renderer>.blurAllObjectsEnabled     BooleanClass    default: true   --  boolean

Get/set the state of the "Blur All Objects" checkbox.

Available in 3ds Max 2013 and higher.

<iray_Renderer>.shutterDurationInFrames     Float    default: 0.5   --  float

Get/set the "Shutter Duration (frames)" value.

Available in 3ds Max 2013 and higher.

<iray_Renderer>.shutterOffsetInFrames     Float    default: -0.25   --  float

Get/set the "Shutter Offset (frames)" value.

Available in 3ds Max 2013 and higher.

<iray_Renderer>.motionSegments     Integer    default: 1   --  integer

Get/set the "Motion Segments" value.

Available in 3ds Max 2013 and higher.

<iray_Renderer>.iterationsPerMotionStep     Integer    default: 16   --  integer

Get/set the "Iterations Per Motion Step" value.

Available in 3ds Max 2013 and higher.

Script-Only Properties

<iray_Renderer>.hardwareReport String default:
"//////////////////////////////////////////////////////////////////////////////          
////////// iray Hardware Support        
//////////////////////////////////////////////////////////////////////////////   
+No supported hardware detected. Using CPUs only." -- string; read-only

<iray_Renderer>.version String default:"2.1-, build 150473.8639 ra, 15 Oct 2011, nt-x86-vc9sp1" -- string; read-only

Contains the version string of the current iRay build.

The default value may vary depending on your version.

Read-only.

iray_Renderer interfaces:

Interface: IMtlRender_Compability_Renderer

Properties:

.displacementParametricSubdivisionLevel : integer : Read|Write|Validated by Range: 0 to 10

.displacementDisplaceMethod : enum : Read|Write
displacementDisplaceMethod enums: {#length|#parametric}

.textureCompressionEnabled : boolean : Read|Write

.textureCompressionMinResolution : integer : Read|Write|Validated by Range: 0 to 32768

Methods:

none

Actions:

none

Interface: mental_ray_iray_options

Properties:

The properties exposed by this interface appear as properties of the renderer and are documented in detail in the beginning of this topic.

<iray_Renderer>.durationInSeconds : integer : Read|Write|Validated by Range: 1 to 1073741824

<iray_Renderer>.durationPasses : integer : Read|Write|Validated by Range: 1 to 1073741824

<iray_Renderer>.durationMode : enum : Read|Write
durationMode enums: {#time|#iterations|#unlimited}

<iray_Renderer>.displacementView : boolean : Read|Write

<iray_Renderer>.displacementSmoothing : boolean : Read|Write

<iray_Renderer>.displacementEdgeLength : float : Read|Write|Validated by Range: 0.0 to 1e+006

<iray_Renderer>.displacementMaximum : float : Read|Write|Validated by Range: 0.0 to 1e+006

<iray_Renderer>.displacementSubdivisionLevel : integer : Read|Write|Validated by Range: 0 to 7

<iray_Renderer>.overrideMaterialEnabled : boolean : Read|Write

<iray_Renderer>.overrideMaterial : material : Read|Write

<iray_Renderer>.lightBouncesLimited : boolean : Read|Write

<iray_Renderer>.lightBouncesMaximum : integer : Read|Write|Validated by Range: 2 to 1073741824

<iray_Renderer>.imageFilterType : enum : Read|Write 

imageFilterType enums: {#box|#gauss|#triangle}

<iray_Renderer>.imageFilterWidth : float : Read|Write|Validated by Range: 0.0 to 8.0

<iray_Renderer>.motionBlurEnabled : boolean : Read|Write

<iray_Renderer>.blurAllObjectsEnabled : boolean : Read|Write

<iray_Renderer>.shutterDurationInFrames : float : Read|Write|Validated by Range: 1e-006 to 1e+008

<iray_Renderer>.shutterOffsetInFrames : float : Read|Write|Validated by Range: -1e+008 to 1e+008

<iray_Renderer>.motionSegments : integer : Read|Write|Validated by Range: 1 to 15

<iray_Renderer>.iterationsPerMotionStep : integer : Read|Write|Validated by Range: 1 to 1024

<iray_Renderer>.NumberOfAllocatedCPUS : integer : Read|Write|Validated by Range: 0 to 8

Methods:

<integer><iray_Renderer>.getNumberOfCPUs()

Returns the number of CPUs installed on the current system.

Available in 3ds Max 2014 and higher.

<integer><iray_Renderer>.getNumberOfCudaGPUs()

Returns the number of CUDA-supporting GPUs installed on the current system.

Available in 3ds Max 2014 and higher.

<bool>isGPUUsedByWindows <integer>index

Returns True if the indexed GPU is used by Windows, False if it is not.

The index is 0-based.

Available in 3ds Max 2014 and higher.

<bool>isGPUUsedByIRay <integer>index

Returns True if the indexed GPU is used by iRay, False if it is not.

The index is 0-based.

Available in 3ds Max 2014 and higher.

<bool>setIRayToUseGPU <integer>index <bool>gpuActive

Sets the user by IRay state of the indexed GPU.

Returns True on success, False on failure (for example, if the index is out of range).

Equivalent to checking/unchecking the checkbox in the UI.

Note that the Render Setup dialog will not update automatically when this method is called - close and reopen the dialog to see the change reflected by the UI.

The index is 0-based.

Available in 3ds Max 2014 and higher.

<string>getGPUName <integer>index

Returns the name string of the indexed GPU.

The index is 0-based.

If the index is out of range, returns an empty string "".

Available in 3ds Max 2014 and higher.

Actions:

none

Interface: mental_ray_iray_diagnostics

Properties:

The properties exposed by this interface appear as properties of the renderer and are documented in detail in the beginning of this topic.

<iray_Renderer>.hardwareReport : string : Read

<iray_Renderer>.version : string : Read

Methods:

none

Actions:

none