The redshiftCmdLine tool allows the rendering of scenes that were exported from you 3d app. This is useful when wanting to render a scene on computers that might not have the necessary 3d app installed on them.
Table Of Contents
How To Export Scenes
Exporting a scene from a 3d app is very similar to exporting a Redshift proxy. In fact, a scene file is a proxy file! Its only difference with a regular proxy file is that it contains not only shaders, geometry and lights but also the current camera, global render options and AOV setup.
To export a proxy scene from Houdini you need to enable the export option available in the Redshift ROP node, Archive tab. Once enabled, the scene export is done rendering to disk from the same ROP node. You can export the current frame, or a frame range.
To export a scene proxy file from Softimage, you will need to configure your scene's archive settings.
First, you need to ensure that Redshift is the current scene renderer. Then, you can configure the filename of the final .rs file via the Archive Filename box in the Render Manager, as shown below
Once the above are done, you can export your scene via Softimage's Export button, as shown below. This will generate one or more (if you're exporting an animation) .rs files.
To export a scene proxy file from Maya, simply select File->Export All. You will then see the following options where you can configure the (optional) animation export options.
Then you can press "Export All" and specify the filename. This will generate one or more (if you're exporting an animation) .rs files.
To export a scene proxy file from 3dsMax, right click in a viewport and select "Redshift Proxy Export" from the menu that appears. Redshift Proxy Export window will show up.
Unselect "Selected only", configure the path, filename, camera and (optional) animation export options and click the "Export" button. This will generate one or more (if you're exporting an animation) .rs files.
To export a scene proxy file simply select the Redshift Proxy option from the File, Export sub-menu.
After specifying an output file, the export options dialog will appear. Adjust the settings and click OK to begin the proxy export process.
If an animation range has been specified, multiple proxy files will be generated based on the filename and path provided.
To export a proxy scene from Katana you need to enable the export option available in the RedshiftRenderSettings node, Archive tab. Once enabled, the export is done using the conventional disk rendering.
To see a list of available arguments, please run redshiftCmdLine without any arguments.
Example: Overriding the path of the final rendered images
When rendering 3d-app-exported scene file with redshiftCmdLine, the rendered images will be saved in the path chosen in the 3d app.
This, however, this can be undesirable because that path might be pointing to a folder that doesn't exist in the computer running redshiftCmdLine!
Let's assume that our scene proxy file "myscene.rs" normally renders these two images in a network folder (drive "z").
If drive "z" is not accessible from the computer we're currently rendering from, we can redirect the images to c:\myfolder via the -oip argument as shown below:
redshiftCmdLine myscene.rs -oip c:\myfolder
Doing so will produce images:
Example: Dumping the list of render options
Running redshiftCmdLine with the -listrenderoptions argument will list the available render options, as shown below.
Example: Overriding render options
We can override render options through the -oro argument.
Let's assume we want to force the unified min/max settings to min:16 and max:64.
We would first need to create a text file (in this case: myrenderoptionsoverrides.txt) containing the following two lines:
Then, we'd pass this text file to redshiftCmdLine as follows:
This would render myscene.rs with the two unified sampling overrides.