Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

In V-Ray it is now possible to access the underlying scene plugins via the Rhino script tools.
A script access manual is provided with the installation of V-Ray. It can be found at the V-Ray for Rhino root folder C:\Program Files\Chaos Group\V-Ray\V-Ray for Rhinoceros\VRayForRhinoObjectModel.html

UI Text Box

type	note

To use the V-Ray for Rhino wrapper module, add a new Python Module Search path pointing to C:\Program Files\Chaos Group\V-Ray\V-Ray for Rhinoceros.

Alternatively, copy the rhVRay.py filefrom C:\Program Files\Chaos Group\V-Ray\V-Ray for Rhinoceros to %APPDATA%\McNeel\Rhinoceros\6.0\scripts and %APPDATA%\McNeel\Rhinoceros\6.0\scripts.

Due to the way V-Ray for Rhino communicates with its UI, certain "user data" parameters are employed while the actual scene parameters are set accordingly only at render time.
The precise names of such "user data" parameters can be found listed in exported V-Ray files:

for Settings - export a .vropt file
for Assets - export an asset of the required type as a .vrmat file

Their parameter handlers contain isUserData="1".

To set a parameter value in the V-Ray UI via a script, the "user data" counterpart must be used. Otherwise, the change will only affect the V-Ray scene.

ParamTypes

Enumeration

Name	Value	Description
T_UNKNOWN	0	Undefined type. Generally an error
T_INTEGER	1	Standard long integer number
T_FLOAT	2	Single precision floating-point number
T_STRING	4	Character string value
T_BOOL	8	Boolean value
T_TRANSFORM	16	Transformation value, consisting of a matrix and a vector. Equivalent to 12-element single-precision floating-point array
T_MATRIX	32	Matrix value. Equivalent to 9-element single-precision floating-point array
T_VECTOR	64	Vector value. Equivalent to 3-element single-precision floating-point array
T_COLOR	128	RGB float color value. Equivalent to 3-element single-precision floating-point array
T_ACOLOR	256	RGBA float color value. Equivalent to 4-element single-precision floating-point array
T_LIST	32768	Binary OR-ed with the other type indicates that the value is a list of values of that type

RenderModes

Enumeration

Property Name	Value	Description
RM_PRODUCTION	0	Renders in production mode
RM_INTERACTIVE	1	Renders in interactive mode
RM_CLOUD	2	Starts the current render job on the Cloud
RM_LAST	3	Repeats the last render

RenderEngines

Enumeration

Property Name	Value	Description
RE_CPU	0	Renders on the CPU
RE_CUDA	1	Renders on the GPU and/or CPU using CUDA
RE_RTX	2	Renders on the GPU using RTX Optix

RhinoScriptComputeDeviceInfo

A structure packing all details for a GPU compute device into a single block

Property Name	Description
Name	The name of the device
UseForRendering	Specifies whether the device is to be used for rendering or not

Name

Name of the device

Syntax:

BSTR Name

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)
name = cudaDevices[0].Name

Tabs Page

title	CPython 3.9

import rh8VRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)
name = cudaDevices[0].Name

Tabs Page

title	C# 9.0

using VRayForRhino;

ComputeDeviceInfo[] cudaDevices = VRay.GetDeviceList(RenderEngines.CUDA).ToArray();
string name = cudaDevices[0].Name;

UseForRendering

Specifies whether the device is to be used for rendering or not

Syntax:

VARIANT_BOOL UseForRendering

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)
use = cudaDevices[0].UseForRendering

Tabs Page

title	CPython 3.9

import rh8VRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)
use = cudaDevices[0].UseForRendering

Tabs Page

title	C# 9.0

using VRayForRhino;

ComputeDeviceInfo[] cudaDevices = VRay.GetDeviceList(RenderEngines.CUDA).ToArray();
bool use = cudaDevices[0].UseForRendering;

RhinoScriptSceneParam

Represents a reference to a NeUI plugin parameter

Property Name	Description
Value	Gets or sets the value of the parameter. Must conform with the value type
Type	Returns the data type of the parameter. Can be OR-ed with ParamTypes::T_LIST
TypeAsString	Returns the data type of the parameter as a string

Value

Gets or sets the value of the parameter. Must conform with the value type

Syntax:

VARIANT Value

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

with vray.Scene.Transaction() as t:
vray.Scene.SettingsOutput.img_width *= 2

Tabs Page

title	CPython 3.9

import rh8VRay as vray

with vray.Scene.Transaction() as t:
vray.Scene.SettingsOutput.img_width *= 2

Tabs Page

title	C# 9.0

using VRayForRhino;

using(Transaction t = VRay.Scene.Transaction())
{
Param img_width = VRay.Scene["SettingsOutput"].Param("img_width");
img_width.Value = (int)img_width.Value * 2;
}

Type

Returns the data type of the parameter. Can be OR-ed with ParamTypes::T_LIST

Syntax:

ParamTypes Type

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

paramType = vray.Scene.SettingsOutput.Param("img_width").Type

Tabs Page

title	CPython 3.9

import rh8VRay as vray

paramType = vray.Scene.SettingsOutput.Param("img_width").Type

Tabs Page

title	C# 9.0

using VRayForRhino;

int paramType = VRay.Scene["SettingsOutput"].Param("img_width").Type

TypeAsString

Returns the data type of the parameter as string.

Syntax:

BSTR TypeAsString

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

paramType = vray.Scene.SettingsOutput.Param("img_width").TypeAsString

Tabs Page

title	CPython 3.9

import rh8VRay as vray

paramType = vray.Scene.SettingsOutput.Param("img_width").TypeAsString

Tabs Page

title	C# 9.0

using VRayForRhino;

string paramType = VRay.Scene["SettingsOutput"].Param("img_width").TypeAsString

RhinoScriptScenePlugin

Represents a reference to a NeUI plugin

Property Name	Description
Params	Returns an array of references to all parameters for the current plugin
ParamNames	Returns an array of strings of all parameter names in the current plugin
Name	Returns the name of the plugin
Category	Returns the category of the plugin
Type	Returns the type of the plugin

Method Name	Description
Param	Returns a reference to a given plugin parameter

Params

Returns an array of references to all parameters for the current plugin

Syntax:

VARIANT Params

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

params = vray.Scene.SettingsOutput.Params

Tabs Page

title	CPython 3.9

import rh8VRay as vray

params = vray.Scene.SettingsOutput.Params

Tabs Page

title	C# 9.0

using VRayForRhino;

Param[] prms = VRay.Scene["SettingsOutput"].Params.ToArray();

ParamNames

Returns an array of strings of all parameter names in the current plugin

Syntax:

VARIANR ParamNames

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

paramName = vray.Scene.SettingsOutput.ParamNames

Tabs Page

title	CPython 3.9

import rh8VRay as vray

paramName = vray.Scene.SettingsOutput.ParamNames

Tabs Page

title	C# 9.0

using VRayForRhino;

string[] paramNames = VRay.Scene["SettingsOutput"].ParamNames.ToArray();

Name

Returns the name of the plugin

Syntax:

BSTR Name

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

pluginName = vray.Scene.SettingsOutput.Name

Tabs Page

title	CPython 3.9

import rh8VRay as vray

pluginName = vray.Scene.SettingsOutput.Name

Tabs Page

title	C# 9.0

using VRayForRhino;

string pluginName = VRay.Scene["SettingsOutput"].Name;

Type

Returns the type of the plugin

Syntax:

BSTR Type

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

pluginType = vray.Scene.SettingsOutput.Type

Tabs Page

title	CPython 3.9

import rh8VRay as vray

pluginType = vray.Scene.SettingsOutput.Type

Tabs Page

title	C# 9.0

using VRayForRhino;

string pluginType = VRay.Scene["SettingsOutput"].Type;

Param

Returns a reference to a given plugin parameter

Syntax:

RhinoScriptSceneParam *Param(
[in, string] BSTR paramName
)

Parameters:

[in] BSTR paramName : Name of the parameter to get

Return:

RhinoScriptSceneParam

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

imgWidth = vray.Scene.SettingsOutput.Param("img_width")

Tabs Page

title	CPython 3.9

import rh8VRay as vray

imgWidth = vray.Scene.SettingsOutput.Param("img_width")

Tabs Page

title	C# 9.0

using VRayForRhino;

Param imgWidth = VRay.Scene["SettingsOutput"].Param("img_width");

RhinoScriptScene

Represents the NeUI scene

Method Name	Description
Plugins	Returns an array of references to all plugins in the scene
PluginNames	Returns an array of strings of all plugin names in the scene

Method Name	Description
Plugin	Returns a reference to a given scene plugin
PluginFromObject	Returns a reference to a plugin that is linked to an Rhino model object, given by ID
PluginsByType	Returns an array of references to all plugins of a given type in the scene
PluginsByCategory	Returns an array of references to all plugins of a given category in the scene
Refresh	Refreshes the NeUI window
Materials	Gets an array of all material plugins in the scene
Lights	Gets an array of all light plugins in the scene
Settings	Gets an array of all settings plugins in the scene
SpecialObjects	Gets an array of all special object plugins (proxies, clippers, furs and infinite planes) in the scene
LoadSettings	Loads a given .vropt file into the scene. The default file will be loaded on failure
SaveSettings	Saves the current settings into a given .vropt file
BeginChange	Opens a transaction to modify the scene. Call EndChange() when done modifying the scene
EndChange	Closes a scene modification transaction, previously opened by a call to BeginChange()

Plugins

Returns an array of references to all plugins in the scene

Syntax:

VARIANT Plugins

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

plugins = vray.Scene.Plugins

Tabs Page

title	CPython 3.9

import rh8VRay as vray

plugins = vray.Scene.Plugins

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] plugins = VRay.Scene.Plugins.ToArray();

PluginNames

Returns an array of strings of all plugin names in the scene

Syntax:

VARIANT PluginNames

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

plugins = vray.Scene.PluginNames

Tabs Page

title	CPython 3.9

import rh8VRay as vray

plugins = vray.Scene.PluginNames

Tabs Page

title	C# 9.0

using VRayForRhino;

string[] pluginNames = VRay.Scene.PluginNames.ToArray();

Plugin

Returns a reference to a given scene plugin

Syntax:

RhinoScriptScenePlugin* Plugin(

[in, string] const BSTR pluginName
)

Parameters:

[in] BSTR pluginName : Name of the plugin to get

Return:

RhinoScriptScenePlugin

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

settingsOutput = vray.Scene.Plugin("/SettingsOutput"

Tabs Page

title	CPython 3.9

import rh8VRay as vray

settingsOutput = vray.Scene.Plugin("/SettingsOutput")

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin settingsOutput = vray.Scene.Plugin("/SettingsOutput");

PluginFromObject

Returns a reference to a plugin that is linked to an Rhino model object, given by ID

Syntax:

VARIANT PluginFromObject(

[in, string] const BSTR id
)

Parameters:

[in] BSTR id : Rhino model object id to query

Return:

RhinoScriptScenePlugin

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vrayPlugin = vray.Scene.PluginFromObject("99dec31e-c736-4f7d-a98c-9dd321396344")

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vrayPlugin = vray.Scene.PluginFromObject("99dec31e-c736-4f7d-a98c-9dd321396344")

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin vrayPlugin = VRay.Scene.PluginFromObject("99dec31e-c736-4f7d-a98c-9dd321396344");

PluginsByType

Returns an array of references to all plugins of a given type in the scene

Syntax:

VARIANT PluginsByType(
[in, string] const BSTR typeName

[in] VARIANT_BOOL onlyTopLevel

)

Parameters:

[in] BSTR typeName : Name of the plugins Type

[in] VARIANT_BOOL onlyTopLevel : VARIANT_TRUE to consider only top-level plugins, or all plugins otherwise. VARIANT_TRUE by default

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vrayMtlAssets = vray.Scene.PluginsByType("MtlSingleBRDF", True)
vrayMtlAll = vray.Scene.PluginsByType("MtlSingleBRDF", False)

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vrayMtlAssets = vray.Scene.PluginsByType("MtlSingleBRDF", True)
vrayMtlAll = vray.Scene.PluginsByType("MtlSingleBRDF", False)

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] vrayMtlAssets = VRay.Scene.PluginsByType("MtlSingleBRDF", true).ToArray();
Plugin[] vrayMtlAll = VRay.Scene.PluginsByType("MtlSingleBRDF", false).ToArray();

PluginsByCategory

Returns an array of references to all plugins of a given category in the scene

Syntax:

VARIANT PluginsByCategory(
[in, string] const BSTR categoryName
[in] VARIANT_BOOL onlyTopLevel
)

Parameters:

[in] BSTR categoryName : Name of the plugins type

[in] VARIANT_BOOL onlyTopLevel : VARIANT_TRUE to consider only top-level plugins, or all plugins otherwise. VARIANT_TRUE by default

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

mtls = vray.Scene.PluginsByCategory("material", True)
all_mtl_plugins = vray.Scene.PluginsByCategory("material", False)

Tabs Page

title	CPython 3.9

import rh8VRay as vray

mtls = vray.Scene.PluginsByCategory("material", True)
all_mtl_plugins = vray.Scene.PluginsByCategory("material", False)

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] mtls = VRay.Scene.PluginsByCategory("material", true).ToArray();
Plugin[] all_mtl_plugins = VRay.Scene.PluginsByCategory("material", false).ToArray();

Refresh

Refreshes the NeUI window

Syntax:

void Refresh()
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.Scene.Refresh

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.Scene.Refresh

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.Scene.Refresh();

Materials

Gets an array of all material plugins in the scene

Syntax:

VARIANT Materials()

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

materials = vray.Scene.Materials

Tabs Page

title	CPython 3.9

import rh8VRay as vray

materials = vray.Scene.Materials

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] materials = VRay.Scene.Materials.ToArray();

Lights

Gets an array of all light plugins in the scene

Syntax:

VARIANT Lights()

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

lights = vray.Scene.Lights

Tabs Page

title	CPython 3.9

import rh8VRay as vray

lights = vray.Scene.Lights

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] lights = VRay.Scene.Lights.ToArray();

Settings

Gets an array of all settings plugins in the scene

Syntax:

VARIANT Settings()

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

settings = vray.Scene.Settings

Tabs Page

title	CPython 3.9

import rh8VRay as vray

settings = vray.Scene.Settings

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] settings = VRay.Scene.Settings.ToArray();

SpecialObjects

Gets an array of all special object plugins (proxies, clippers, furs and infinite planes) in the scene

Syntax:

VARIANT SpecialObjects()

Return:

VARIANT array of RhinoScriptScenePlugin
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

specialObj = vray.Scene.SpecialObjects

Tabs Page

title	CPython 3.9

import rh8VRay as vray

specialObj = vray.Scene.SpecialObjects

Tabs Page

title	C# 9.0

using VRayForRhino;

Plugin[] specialObj = VRay.Scene.SpecialObjects.ToArray();

LoadSettings

Loads a given .vropt file into the scene. The default file will be loaded on failure

Syntax:

VARIANT_BOOL LoadSettings( [in, string] const BSTR fileName )

Parameters:

[in] BSTR fileName : Name of the file to load in

Return:

None-zero if succeeded, zero if failed
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

success = vray.Scene.LoadSettings("Rhino Default.vropt")

Tabs Page

title	CPython 3.9

import rh8VRay as vray

success = vray.Scene.LoadSettings("Rhino Default.vropt")

Tabs Page

title	C# 9.0

using VRayForRhino;

bool success = VRay.Scene.LoadSettings("Rhino Default.vropt");

SaveSettings

Saves the current settings into a given .vropt file

Syntax:

VARIANT_BOOL SaveSettings( [in, string] const BSTR fileName )

Parameters:

[in] BSTR fileName : Name of the file to write out

Return:

None-zero if succeeded, zero if failed
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

success = vray.Scene.SaveSettings("settings.vropt")

Tabs Page

title	CPython 3.9

import rh8VRay as vray

success = vray.Scene.SaveSettings("settings.vropt")

Tabs Page

title	C# 9.0

using VRayForRhino;

bool success = VRay.Scene.SaveSettings("settings.vropt");

BeginChange

Opens a transaction to modify the scene. Call EndChange() when done modifying the scene

Syntax:

void BeginChange()

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.Scene.BeginChange()
# scene modification statements
vray.Scene.EndChange()

# or in a RAII-manner
with vray.Scene.Transaction():
# scene modification statements.
# exiting the scope is equivalent to calling vray.Scene.EndChange()

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.Scene.BeginChange()
# scene modification statements
vray.Scene.EndChange()

# or in a RAII-manner
with vray.Scene.Transaction():
# scene modification statements.
# exiting the scope is equivalent to calling vray.Scene.EndChange()

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.Scene.BeginChange();
// scene modification statements
VRay.Scene.EndChange();

// or in a RAII-manner
using(Transaction tr = VRay.Scene.Transaction())
{
// scene modification statements.
// exiting the scope is equivalent to calling VRay.Scene.EndChange()

EndChange

Closes a scene modification transaction, previously opened by a call to BeginChange()

Syntax:

void EndChange()

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.Scene.BeginChange()
# scene modification statements
vray.Scene.EndChange()

#or in a RAII-manner
with vray.Scene.Transaction():
# scene modification statements.
# exiting the scope is equivalent to calling vray.Scene.EndChange()

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.Scene.BeginChange()
# scene modification statements
vray.Scene.EndChange()

#or in a RAII-manner
with vray.Scene.Transaction():
# scene modification statements.
# exiting the scope is equivalent to calling vray.Scene.EndChange()

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.Scene.BeginChange();
// scene modification statements
VRay.Scene.EndChange();

// or in a RAII-manner
using(Transaction tr = VRay.Scene.Transaction())
{
// scene modification statements.
// exiting the scope is equivalent to calling VRay.Scene.EndChange()

RhinoScriptObject

Represents the NeUI scene

Property Name	Description
Scene	Returns the currently active scene
Version	Returns the current plugin version
VRayVersion	Returns the current V-Ray core version

Method Name	Description
Render	Starts a V-Ray render
CancelRender	Stops the current rendering process
RefreshUI	Refreshes the NeUI asset manager window
GetDeviceList	Returns the compute devices available on the machine for a given render mode
SetDeviceList	Sets a list of devices available on the machine, to be used for a given render mode

Scene

Returns the currently active scene

Syntax:

RhinoScriptScene* Scene

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

scene = vray.Scene

Tabs Page

title	CPython 3.9

import rh8VRay as vray

scene = vray.Scene

Tabs Page

title	C# 9.0

using VRayForRhino;

Scene scene = VRay.Scene;

Version

Returns the current plugin version

Syntax:

int Version

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

version = vray.Version

Tabs Page

title	CPython 3.9

import rh8VRay as vray

version = vray.Version

Tabs Page

title	C# 9.0

using VRayForRhino;

int version = VRay.Version;

VRayVersion

Returns the current V-Ray core version

Syntax:

int VRayVersion

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray_version = vray.VRayVersion

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray_version = vray.VRayVersion

Tabs Page

title	C# 9.0

using VRayForRhino;

int vray_version = VRay.VRayVersion;

Render

Starts a V-Ray render

Syntax:

void Render(
[in] RenderModes mode,
[in] RenderEngines engine,
[in] int timeout
)

Parameters:

[in] RenderModes mode: Specifies the mode the render job shall be executed in

[in] RenderEngines engine: Specifies the render engine to use for the current render job

[in] int timeout: Specifies whether the current render job shall be executed synchronously or asynchronously.
Use -1 for syncrhonous renders, and >=0 for specific wait timeout in milliseconds

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.Render(0, 0, -1)

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.Render(0, 0, -1)

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.Render(0, 0, -1);

CancelRender

Stops the current rendering process

Syntax:

void CancelRender()
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.CancelRender()

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.CancelRender()

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.CancelRender();

RefreshUI

Refreshes the NeUI asset manager window

Syntax:

void RefreshUI()
Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

vray.RefreshUI()

Tabs Page

title	CPython 3.9

import rh8VRay as vray

vray.RefreshUI()

Tabs Page

title	C# 9.0

using VRayForRhino;

VRay.RefreshUI();

GetDeviceList

Returns the compute devices available on the machine for a given render mode

Syntax:

VARIANT GetDeviceList(RenderEngines engine)

Return:

VARIANT

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)

Tabs Page

title	CPython 3.9

import rh8VRay as vray

cudaDevices = vray.GetDeviceList(vray.RenderEngines.RE_CUDA)

Tabs Page

title	C# 9.0

using VRayForRhino;

ComputeDeviceInfo[] cudaDevices = VRay.GetDeviceList(RenderEngines.CUDA).ToArray();

SetDeviceList

Sets a list of devices available on the machine, to be used for a given render mode

Syntax:

VARIANT_BOOL SetDeviceList(RenderEngines engine, VARIANT ids)

Return:

VARIANT_BOOL

Examples:

Divbox

style	background-color:#e6f3ff; font-family: monospace

Tabs Container

direction	horizontal

Tabs Page

title	IronPython 2.7

import rhVRay as vray

success = vray.SetDeviceList(vray.RenderEngines.RE_CUDA, [0, 1])

Tabs Page

title	CPython 3.9

import rh8VRay as vray

success = vray.SetDeviceList(vray.RenderEngines.RE_CUDA, [0, 1])

Tabs Page

title	C# 9.0

using VRayForRhino;

bool success = VRay.SetDeviceList(RenderEngines.CUDA, new int[]{ 0, 1 });

Content

Space Tools

Page History

Versions Compared

Old Version 28

New Version Current

Key

ParamTypes

RenderModes

RenderEngines

RhinoScriptComputeDeviceInfo

Name

RhinoScriptSceneParam

Value

Type

TypeAsString

RhinoScriptScenePlugin

Params

ParamNames

Name

Category

Type

Param

RhinoScriptScene

Plugins

PluginNames

Plugin

PluginFromObject

PluginsByType

PluginsByCategory

Refresh

Materials

Lights

Settings

SpecialObjects

LoadSettings

SaveSettings

BeginChange

EndChange

RhinoScriptObject

Scene

Version

VRayVersion

Render

CancelRender

RefreshUI

GetDeviceList

SetDeviceList