This page introduces command-line parameters for V-Ray Standalone.

 

Page Contents

 

Overview


Below is a list of the command-line parameters for V-Ray Standalone. You can use the VRAY_CMD_PREFIX and VRAY_CMD_SUFFIX environment variables to specify additional command-line parameters – see the V-Ray Standalone Environment Variables page. If you run V-Ray Standalone without any parameters, it will also print a short help text with descriptions of each possible option. Portions of the options in square brackets [] are optional and portions in curly braces {} can be repeated zero or more times.

 

System Options


-help – Prints out a list of all the available command lines and their usage.

-version – Prints the V-Ray version.

-credits – Prints copyright notices for V-Ray and available plugins.

-configFile="path/to/config/file" – The path and file name to the V-Ray config file, which contains paths to the V-Ray plugins. Note that additional paths for V-Ray plugins can also be specified with the VRAY_PLUGINS_x86 and VRAY_PLUGINS_x64 environment variables. The default is vrayconfig.xml in the same folder as vray.exe.

-numThreads=nnn – Sets the number of rendering threads. The default is 0 - automatic number of threads.

-interactive=0/1 – Enables and disables the interactive mode. The default value is 0, which means the interactive mode is disabled. Enabling it allows the user to access and modify the render settings saved in the .vrscene file. These are the same options that can be found in the Render Settings dialogue in Maya or Render Setup in 3ds Max. Having access to those controls allows the user to change them without having to re-export the .vrscene from either 3ds Max or Maya.

 

Render Output


-imgFile="fileName" – Writes the resulting image to the given file. If the file name is empty, no image will be written. Alternatively, files can be saved without using this option in cmd if path (img_dir) and filename (img_file) are defined in the .vrscene output settings content.

-imgWidth=nnn – Sets the output image width. The default is 640 or as specified in the .vrscene file.

-imgHeight=nnn – Sets the output image height. The default is 480 or as specified in the .vrscene file.

-region=x0;y0;x1;y1 – Sets the region to render. The integer values are in pixels, relative to the upper-left corner of the image. The default is full image or as specified in the .vrscene file. Use -region=none to disable region rendering, even if a region is specified in the .vrscene file.

-region=none – Ignores any the region specified in the .vrscene file

-crop=x0;y0;x1;y1 – Sets the crop region to render. The integer values are in pixels, relative to the upper-left corner of the image. The default is full image or as specified in the .vrscene file.

-frames=b0[-e0[,s0]]{;bn[-en[,sn]]} – Specifies the frames and/or frame intervals to render. More than one -frames option can be specified: bX is the start frame, eX is the end frame, and sX is the frame increment. If not specified, the frames from the scene description are rendered.

Example    Description
-frames=1;3;5-10Render frames 1, 3 and 5 to 10 inclusively
-frames=10-100,5Render every 5-th frame starting from 10 to 100 (i.e. 10, 15, 20, 25, ..., 95, 100)

-noFrameNumbers=0/1 – Controls whether the -frames option will cause frame numbers to be automatically appended to the names of the rendered image files. The default value is 0 where the -frames option always causes frame numbers to be added to the output image files.

-skipExistingFrames=0/1– Controls whether V-Ray renders frames from the specified frame range that currently exist in the output folder.

-resume=0/1– V-Ray will resume rendering partially completed renders. This is only for bucket renders (non-deep images) when writing to .vrimg.

-progressiveAutoSave= – Specifies an interval in minutes for saving resumable files during rendering. This applies only for progressive sampling; bucket renderings are saved on every completed bucket. A value of 0 disables autosaving during rendering, and resumable files will be saved only at the end of the rendering.


VFB (V-Ray Frame Buffer) Display Options


-display=0/1 – Shows the rendered image in the V-Ray frame buffer. The default value is 1, which shows the rendered image.

-autoClose=0/1 – Automatically closes the displayed image when rendering is complete. The default value is 0, which waits for user to close the VFB.

-setFocus=0/1 – Sets the focus on the VFB window if displayed. The default value is 1 which sets the focus on the VFB window. This works reliably only on Windows.

-displaySRGB=0/1/2 – Determines if the sRGB option of the V-Ray VFB will be turned on or off initially. A value of 0 means the default value for the VFB will be used (which usually has sRGB enabled). A value of 1 forces the sRGB button to be enabled. A value of 2 forces the sRGB button to be disabled. This can also be specified with the VRAY_VFB_SRGB environment variable. The command line option overrides the environment variable. The default is 0, where sRGB is the VFB default (enabled).

-displayLUT=0/1 – Determines if the LUT option of the V-Ray VFB will be turned on or off initially. This can also be specified with the VRAY_VFB_LUT environment variable. The command line option overrides the environment variable. The LUT file itself can be specified with the VRAY_VFB_LUT_FILE environment variable. The default is 0, where LUT is off.

-displayAspect=0/1 – Determines if the pixel aspect option of the V-Ray VFB will be turned on or off initially. This can also be specified with the VRAY_VFB_PIXEL_ASPECT environment variable. The command line option overrides the environment variable. The default value is 0, where pixel aspect is off.

 

Console Output


-verboseLevel=n – Specifies the verbose level of information printed to the standard output:

0 – No information is printed.
1 – Only errors.
2 – Errors and warnings.
3 – Errors, warnings, and informational messages.
4 - All output.

The default is 3.

-showProgress=n – Specifies whether calculation progress should be printed to the standard output:

0 – Do not display progress.
1 – Display progress only if verboseLevel is > 0.
2 – Always display progress.

The default is 1.

-progressUpdateFreq=n – Specifies the render progress update frequency in milliseconds. The default value is 200 ms. Only one of -progressUpdateFreq and -progressIncrement is used, depending on which is specified last on the command line.

-progressIncrement=n – Specifies the progress increment in percentage when a new progress message will be printed. Only one of -progressUpdateFreq and -progressIncrement is used, depending on which is specified last on the command line.

-progressUseCR=0/1 – Controls how to use carriage return when printing render progress information.

 

RT Engine


-rtEngine=0/1/3/5 – Specifies which rendering engine is going to be used:

0 – The regular render engine is used.
1 – The CPU RT engine is used.
3 – The GPU RT engine running on OpenCL is used.
5 – The GPU RT engine running on CUDA is used.

The default is 0.

-rtTimeOut=fff – Specifies a floating-point render time value (in minutes) when using the RT engine. The default is 0.0, no time limit.

-rtNoise=fff – Specifies floating-point noise threshold for a frame when using the RT engine. The default is 0.001.

-rtSampleLevel=nnn – Specifies maximum number of paths per pixel for a frame when using the RT engine. The default is 0, no limit.

 

Distributed Render


-distributed=0/1/2 – Specifies whether and how to use distributed rendering:

0 – Distributed rendering is disabled.
1 – Distributed rendering is enabled, and the local machine is included in the rendering.
2 – Distributed rendering is enabled and the local machine is excluded from the rendering.

The default is 0.

-renderhost="host{;host}" – A semicolon separated list of hosts to use for distributed rendering. Hosts can be specified either as computer names or by IPs. More than one -renderhost options can be specified.

-portNumber=n – Specifies the port number to use for distributed rendering. The port numbers of the render servers and the render client must match for DR to work. The port can also be overridden using the VRAY_DR_CONTROLPORT environment variable. This command line option overrides the environment variable. The default is 20204

-transferAssets=0/1/2 – Specifies whether missing assets should be transferred to the DR servers:

0 – Do not transfer.
1 – Transfer missing assets.
2 – Check for assets in the asset cache folder before transferring them. The VRAY_ASSETS_CACHE_PATH environment variable can be used to specify the asset cache folder; if it is not specified, the assets are stored in a directory "vray_assets_cache" inside the temp folder for the current user.

The default is 0.

 

Command Mode


-cmdMode=0/1/2 – Specifies if command mode is disabled, enabled through TCP/IP only, or enabled through TCP/IP and the keyboard. See the V-Ray Standalone Command Mode page for more details. The default is 0, where command mode is disabled.

-cmdPort=nnnn – Specifies the TCP/IP port number for the command mode. The default is 4368.