DzIrayRenderer

The NVIDIA Iray renderer.

More...

Inherits :

• QObject
  • DzBase
    • DzRenderer

Implements a Physically Based Rendering (PBR) interface for the scene to render itself through the NVIDIA Iray renderer.

DzIrayRenderer()

Default Constructor.

Boolean : getAllowCPUFallback()

Since:

• 4.12.1.81

Boolean : getAllowGPUDetection()

Since:

• 4.12.1.81

Number : getCPULoadLimit()

Return Value:

• The CPU load limit for the NVIDIA Iray renderer.

Since:

• 4.12.1.81

Boolean : getCPUThreadAffinityEnabled()

Return Value:

• true if CPU thread affinity is enabled, otherwise false.

Since:

• 4.12.1.81

Boolean : getGPUDriverCheck()

Since:

• 4.12.1.81

Number : getGPULoadLimit()

Return Value:

• The GPU load limit for the NVIDIA Iray renderer.

Since:

• 4.12.1.81

Number : getHighThreshold()

Since:

• 4.12.1.81

Number : getMediumThreshold()

Since:

• 4.12.1.81

Number : getNVLINKPeerGroupSize()

Since:

• 4.12.1.81

DzElement : getPropertyHolder()

Return Value:

• The element that holds the properties for this renderer.

Boolean : isIPRRendering()

Return Value:

• true if this renderer is currently performing an interactive progressive render, otherwise false.

void : setAllowCPUFallback( Boolean onOff )

Since:

• 4.12.1.81

void : setAllowGPUDetection( Boolean onOff )

Since:

• 4.12.1.81

Boolean : setCPULoadLimit( Number limit )

Sets the CPU load limit for the NVIDIA Iray renderer.

The CPU load is the sum of CPU loads caused by all currently active threads. A single thread fully using a single CPU core is said to cause a CPU load of 1.0. The CPU load limit defaults to the number of CPU cores.

Parameter(s):

• limit - The new CPU load limit. This value may be clamped against some upper bound imposed by license restrictions.

Return Value:

• true if the limit was successfully set, false if the new limit was not set (e.g., invalid - less than 1.0).

Since:

• 4.12.1.81

Boolean : setCPUThreadAffinityEnabled( Boolean onOff )

Sets the affinity of CPU threads.

Parameter(s):

• onOff - If true, threads are bound to the CPU they are currently running on. If false (default), the operating system is free to migrate threads between CPUs as it sees fit (which may suffer from cache misses).

Attention:

• This setting is not supported on macOS. This setting only affects internal threads that are used to execute renders. Application threads are not affected. Changing this value does not affect a render that is currently being executed, it only affects subsequently started renders.

Return Value:

• true if thread affinity was successfully set, otherwise false.

Since:

• 4.12.1.81

void : setGPUDriverCheck( Boolean onOff )

Since:

• 4.12.1.81

Boolean : setGPULoadLimit( Number limit )

Sets the GPU load limit for the NVIDIA Iray renderer.

The GPU load is the sum of GPU loads caused by all currently active threads. A single thread fully using a single GPU is said to cause a GPU load of 1.0. The GPU load limit defaults to the number of GPUs.

Parameter(s):

• limit - The new GPU load limit. This value may be clamped against some upper bound imposed by license restrictions.

Return Value:

• true if the limit was successfully set, false if the new limit was not set (e.g., invalid - less than 1.0).

Since:

• 4.12.1.81

void : setHighThreshold( Number val )

Since:

• 4.12.1.81

void : setMediumThreshold( Number val )

Since:

• 4.12.1.81

void : setNVLINKPeerGroupSize( Number size )

Since:

• 4.12.1.81