Callback

Description

Init (Renderer)

Fired after the plug-in loaded (that is, after XSILoadPlugin returns). For example, Init is fired when you start Softimage or load the plug-in in the Plugin Manager.

Used to tell Softimage which process types the rendering engine supports, which custom property to use for the renderer options, and which image file formats it can output.

Process

Fired whenever the rendering engine is requested to perform a process (for example, render a frame). This is the most important callback for a custom renderer plug-in.

Abort

Fired when the Render Manager needs to abort a process. This callback function is simply the messenger, it should trigger an abort and return as quickly as possible.

Quality

Optional. Called by the Render Manager to both return the current quality level of the render options and to set a preset for the given quality level.

Query

Optional. Called by the Render Manager to query the renderer for information based on the siRenderQueryType enumeration value given in the QueryType attribute.

Cleanup

Optional. Fired when the current scene is being destroyed, or if the specific render process (region, pass render, etc.) requests that data be cleaned up after the process has completed.

Unload, Reload

Fired when the plug-in is cached (reloaded) and uncached (unloaded). By default, all plug-ins are cached, but users can remove a plug-in from the cache (by right-clicking a plug-in in the plug-in tree and clearing the Cached checkmark).