Versions Compared

Key

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

The following procedures, when defined, allow customization of Render Passes:

global proc DL_userRenderPassCreate (string $render_pass)

This procedure is called as the last step of the render pass node creation procedure. It could be used to configure a render pass node with different values than the default ones. It can also be used to add various custom attributes, in which case it might be useful to also define DL_userRenderPassAEtemplate().

global proc DL_userRenderPassUpdate (string $render_pass)

This procedure is called when a scene is opened or referenced. It can be used to update custom render pass attributes of older scenes. 

Warning

The following procedure is deprecated. Please use the DL_userRenderPassCreate and DL_userRenderPassUpdate procedures, explained above.

global proc DL_userRenderPassInit (string $render_pass)

This procedure is called as the last step of the render pass node creation procedure. It is also called as the last step of the DRP_Init() procedure. It could be used to configure a render pass node with different values than the default ones. It can also be used to add various custom attributes, in which case it might be useful to also define DL_userRenderPassAEtemplate(). Finally, it can be used to

...

update custom render pass attributes of older scenes. It should be desgined so that it can be called several times with the same render pass node during a session.

global proc DL_userRenderPassAEtemplate (string $render_pass)

...

This procedure is called whenever the list of display drivers is needed. It is expected to return the complete list of display drivers to be used in the user interface. The list of the display drivers packaged with 3Delight can be retrieved with DRP_getDefaultDisplayDrivers; if they are desired, they must be added to the string array returned by DL_userGetAllDisplayDrivers. The returned list should at least contain "idisplay" and "maya_render_view" somewhere in the array.

global proc string[] DL_userGetAllDisplayAOVs ()

...

String ElementDescription

type=<element type>

__________________________

Specifies the type of menu item. Supported types are:

"separator" -

The menu item will be a separator (divider). Other parameters will be ignored.

"menu" -

The menu item will pop up a sub menu when selected. The sub menu will be populated with the elements corresponding to the string array returned by a procedure defined by the `itemsproc' parameter.

"aov" -

The menu item is an AOV. The actual full declaration of the AOV must be specified by the varname parameter. If a label parameter is specified, it will be used to define this menu item's text label. If no label is specified, the correct element from DL_userGetAllDisplayAOVs will be used whenever possible. The varname is used as a label as a last resort.

label=<label string>

Specifies the label to use for this menu item.

itemsproc=<procedure name>Specified the name of a procedure to populate a sub menu. Only relevant when specified along with type=menu. The procedure is expected to take no arguments and return a string array listing the needed menu items.
varname=<aov name>Specifies the full declaration of the AOV. This declaration is when will be set in the display's Output Variable text field. It should be identical to an element of DL_userGetAllDisplayAOVDeclarations if the menu item's label is to be determined automatically using DL_userGetAllDisplayAOVs and to allow correct AOV identification in the display's frame layout label in the Attribute Editor.
varindex=<index>Specifies the index of the arrays returned by DL_userGetAllDisplayAOVs and DL_userGetAllDisplayAOVDeclarations that should be used to determine the aov name and declaration, respectively.