Versions Compared

Key

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

Using Maya's

...

Render

...

 Command Line

3Delight renders can be launched using Maya’s Render command line with the '-r 3delight' option. If no additional parameters are provided on the command line, rendering will occur using the Render Settings that is active in the render settings window when the scene was saved.

The options contained in the Render Settings can be overridden using the command line interface. The following command is useful to list the . When launching renders this way, many command line parameters are supported to control just about every aspect of the rendering process. The following command lists the supported parameters specific to the 3Delight for Maya plug-in:

Render -r 3delight -help

Issuing the Render command with only the '-r 3delight' option will render the Render Pass that is active in the Render Settings window when the scene was saved (see also The Render Pass). But most of its rendering attributes can be overridden with the command line interface. The available parameters to override these attributes are listed below. If you need to set a Render Pass attribute that is not listed, please send a request to technical support. Refer to The Render Here is a description of the available parameters (refer to Render Settings for more information about the effect of each Render Pass attributes.

...

options):

Expand
titleExpand to view

...

the command line parameters...


Render

...

Settings Selection

-

...

rendersettings <string>

...

-rs ?

Specifies the name of the Render Settings to render with. Multiple Render Settings can be specified using a comma-separated list of

...

names. Specifying

...

all

...

will sequentially render all Render

...

Settings defined in the scene. Examples:

ex 1:

...


Render -r 3delight -rendersettings settings1

ex 2:  
Render -r 3delight -rendersettings settings1,settings2


ex 3:
Render -r 3delight -rendersettings all


Info

...

Because this option defines which

...

render settings will be edited by subsequent flags, it should be specified

...

immediately after the ‘-r 3delight’ option.


Mode
-export <string>

...

Export to the specified NSI file instead of rendering the images. The <string> parameter specifies the NSI filename to create.

Scene Elements (maybe remove all these options?)

-cam <string>

not listed with -help

Select <string> as the camera to be rendered.

-

...

Set the shader collection to render. Specify an empty string to use no shader collections.

objects <string>

not listed with -help

...

Set the

...

objects set to render. Specify an empty string to render all visible objects.

-

...

Set the light set to render. Specify an empty string to render all visible lights.

lights <string>

not listed with -help

...

Set the

...

-lr <boolean|name(s)> 

...

Specify the Maya render layer to render. It is possible to specify multiple layer names, as long as they are separated by a space and the list is surrounded by double quotes. If this parameter is set to ‘on’, ‘true’ or ‘1’, all renderable layers will be rendered. If an empty string, ‘off’, ‘false’ or ‘0’ is specified, the defaultRenderLayer (or masterLayer) will be used. When this parameter is not specified, all renderable layers will be rendered, unless the selected Render Pass specifies which layer is to be rendered with its Layer To Render attribute. In this case, only this layer will be rendered, provided it is renderable. If it is not renderable, nothing will be rendered.

...

-shp <string>

...

Specify the shaders search path.

...

-txp <string>

...

Specify the textures search path.

...

-prp <string>

...

Specify the procedural search path.

lights set to render. Specify an empty string to render all visible

...

lights.

Frame Range 
-

...

animation <boolean>Toggle the rendering of the specified frame sequence (animation) on or off.

-

...

start <int>

-s float ?

Set the first frame to render. This implicitly sets -animation to true.

-

...

end <int>

-e float ?

Set the last frame to render. This implicitly sets -animation to true.

-inc <int>

-increment float ?

Set the frame increment.

...

This implicitly sets -animation to true.

Image Resolution and Crop

-x <int>

not listed with -help

Set the X resolution of the rendered image.

-y <int>

not listed with -help

Set the Y resolution of the rendered image.

-

...

Specify the resolution multiplier. The following values are available:

  • ‘0’  Full resolution.

  • ‘1’  One half of the specified resolution.

  • ‘2’  One quarter of the specified resolution.

  • ‘3’  One eighth of the specified resolution.

par <float>

not listed with -help

...

Specify the pixel aspect ratio of the rendered image.
-crop <boolean>Controls if the specified crop window is used for rendering.

-

...

cropmin <float> <float>

Set the top right corner position of the crop window in X

...

and Y, respectively. This implicitly sets -crop to true.
-

...

cropmax <float> <float>Set the bottom left corner position of the crop window in X

...

Toggle the use of imager shaders attached to the specified camera.

...

-pdm <string>

...

Set the primary display output variable.

...

-pdbd <int>

and Y, respectively. This implicitly sets -crop to true.
Quality (maybe remove all these options except pixel/shading samples?)
-pixelsamples <int>Set the number of pixel samples to use.
-shadingsamples <int>Set the number of shading samples to use.

-pixelfilter <int>

-pixlefilter <string> ?

Set the pixel filter type

...

. The following values are available:

  • ‘0’

...

  •  Gaussian filter

  • ‘1’

...

  •  Mitchell filter

  • ‘2’

...

  •  Catmull-rom filter

  • ‘3’

...

-pdqzero <int>

...

-pdqone <int>

...

Set the primary display "one" value for quantization. 

...

-pdqmin <int>

...

Set the primary display minimum value for quantization.

...

-pdqmax <int>

...

Set the primary display maximum value for quantization. 

...

-pdqdit <float>

...

Set the primary display "dither" value for quantization.

...

-rsd <boolean> 

...

Toggle the rendering of the secondary displays on or off

...

Specify the render mode. The following values are available:

  • ‘0’  Render

  • ‘1’  Save RIB

  • ‘2’  RIB Archive

...

Specify the bucket order to be used. The following values are available:

  • ‘0’  Horizontal bucket order.

  • ‘1’  Vertical bucket order.

  • ‘2’  Zigzag bucket order.

  • ‘3’  Spiral bucket order.

  • ‘4’ Circle bucket order.   

...

  •  Sinc filter

  • ‘4’  Box

  • '5' Triangle
-filterwidth <float>Set the pixel filter width.

-maxdistance <float>

-maxdistance <int> ?

Defines the maximum distance a ray can travel.

-motionblur <boolean> 

-motionBlur <boolean> ?

Toggle motion blur on or off.

Additional options not yet implemented


Expand
titleExpand to view...


-overridesEnable the use of the Overrides options from the Render Settings (by default they are always ignored during batch rendering)

...

.
Performance
-cpus <int>Define the number of threads to use. The default is to use all available threads.
-

...

texturememory <int>Set the size of the texture memory cache, in megabytes.

-

...

netcache <boolean>

maybe remove this and use netcache size instead (as in 3delight.config)

Toggle the use of network cache on or off. (Use to override the setting in the 3delight.config configuration file.)

-

...

netcachedirectory <string>

Set the network cache directory.

...

Toggle output of the rendering statistics.

...

Set the pixel filter type. The following values are available:

  • ‘0’  Box filter

  • ‘1’  Triangle filter

  • ‘2’  Gaussian filter

  • ‘3’  Catmull-rom filter

  • ‘4’  Bessel filter

  • ‘5’  Sinc

...

-rtmaxd <int>

...

Depth of Field

...

 

...

None available.

...

Motion Blur

...

-cmbs <int>

...

-tmb <boolean>

...

-dmbs <int>

...

Set the motion blur position. The following values are available:

  • ‘0’ End on frame 
  • ‘1’  Centered on frame  
  • ‘2’  Start on frame

...

Define the shutter opening efficiency.

...

Define the shutter closing efficiency.

...

Set the shutter angle for motion blur. <float> should be between 1 and 360.

...

Toggle autotmatic shadow map rendering on or off.

...

Shadow linking. The available values are:

  • ‘0’  Use Light Links. 
  • ‘1’  Use Shadow Links.   
  • ‘2’  Ignore Light and Shadow Links.

...

-arl <int>

...

Specify how to archive lighting. The following values are available:

  • ‘0’  No Lighting. 
  • ‘1’  Light Linking.  

Light Sources & Light Linking 

...

-arw <int> 

...

Set the archive write mode. The following values are available:

  • ‘0’  Reuse existing archive.

  • ‘1’  Overwrite existing archive.

...

-grar <boolean>

...

Generate RIB archives toggle.

...

-iao <boolean>

...

Ignore archived objects toggle.

...

-art <boolean>

...

Archive transforms toggle.

...

-cgt <boolean>

...

Concatenate geometry transforms toggle.

...

-args <boolean>

...

Archive geometry shaders toggle.

...

-args <boolean>

...

Archive geometry attributes toggle.

...

 

...

None available.

...

(Use to override the setting in the 3delight.config configuration file.)

-netcachesize <int>Set the network cache size, in gigabytes. (Use to override the setting in the 3delight.config configuration file.)
Progress
-progress <boolean>

Toggle output of the rendering progress into the "shell".

MEL Scripts

-prerender

...

<string>

MEL script executed before rendering.
-

...

postrender <string>MEL script executed after rendering.
-

...

preframe <string>MEL script executed before each frame.
-

...

postframe <string>MEL script executed after each frame.

...

-bsx <int>

...





Using 3Delight's

...

renderdl

...

 Command Line

...

...

Offline rendering can also be launched using 3Delight

...

s standalone

...

renderer renderdl

...

  — provided the scene have been exported to a

...

NSI File. To render a file named file.nsi, just type:

Code Block
renderdl file.nsi 

To read more about about the renderdl command line, refer to Rendering NSI file.

renderdl -h

For a complete description of 3Delight's standalone renderer renderdl refer to 3Delight Studio Pro User Manual.pdf (in the PDF: chapter 3.1 Using the RIB Renderer - renderdl).

...