Custom Render Flags

Custom options for a render application

You can create new checkboxes and value-spinboxes in the rrSubmitter to set special flags in the render commandline of a renderer application.

You can use the option to switch the use for anything.

Hint: Some renderer use custom render scrips which you can extend with new options. (Maya, Softimage, Houdini, Modo)

Example custom settings are:

- Arnold denoice variance value

- enable/disable motion blur

- set the ray depth level

The render config A80__Arnold_StdA_DeNoice.cfg includes multiple Custom Options, please see the file as an example.

Create the Option:

Add a line

COYourCustomName= AllowChange ~ Checked ~ Value

to the render config.

We recommend to add it in section "Render Settings" or "Submitter Settings". (these sections are just for human readability and have no use for RR itself)

Limitation:

The maximum length of a Custom Options name is 25 letters!

(Including "Float", explained later)

1) The first part is "AllowChange".
If the artist is allowed to change it in the rrSubmitter.

COYourCustomName= 1	Artist can change it
COYourCustomName= 0	Artist is not allow to change it

2) The next part is the "Checked".
If the option is checked by default or not.

This one is checked:

COYourCustomName= 1 ~ 1	Custom option checked
COYourCustomName= 1 ~ 0	Custom option not checked

3) The last part is "Value".

This is optional.

If you just want a checkbox, then do not add the last part ~ Value

If you want a value spinbox, add this last part.

Example default value 345: COYourCustomName= 1 ~ 1 ~ 345

If you need a float spinbox, then your Custom Option's name has to end with "Float".

The value in the render config is still an integer and will be divided by 100 by RR.
Therefore the float precision is limited to 2 digits as well.

Example default value 0.25: COYourCustomName= 1 ~ 1 ~ 025

Use the new option

You can now use the parameter in your commandline.

You can use the new parameter as boolean switch or directly use the value.

See Variables as value or condition.

Use the checked state (0/1) or for custom options with a value the value:

Use as conditional flag:

Conditional flag with value:

<COShadowMaps -shMap on -shMapResolution <COShadowMaps> ? -raytrace on>

Hint:

You can also use this new COYourCustomName= in your submitter default files to use different settings for different projects.

Examples

Checkbox to add commandline flag "-disableRenderError True"

If your commandline, add
<CODisableRenderError -disableRenderError True>

At some other location, add the definition

CODisableRenderError= 1 ~ 0

The first "1" means the artist is allowed to change the value.
The second "0" means the checkbox is disabled by default.

Checkbox to switch between commandline flags "-disableRenderError True" and "-disableRenderError False"

If your commandline, add
-disableRenderError <CODisableRenderError True ? False>

At some other location, add the definition

CODisableRenderError= 1 ~ 0

Add an integer flag

If your commandline, add
<COSearchRadius -sr <COSearchRadius> >

At some other location, add the definition

COSearchRadius= 1 ~ 1 ~ 9

The third parameter is the default value for the number.

Add a float flag

To use a floating point value, you have to add "Float" to the end of the name

If your commandline, add
<COVarianceFloat -v <COVarianceFloat> >

At some other location, add the definition

COVarianceFloat= 1 ~ 1 ~ 025

The third parameter is the default value.

Note that the config file still uses an int without decimal point.
The int is divided by 100.
Which means 025 will be 0.25.
And therefore the precision of the float is limited to 2 digits.