Pass

class guerilla.Pass

Bases: guerilla.RenderOutput

A render pass reacts to renders by pushing jobs into a job queue.

Each job is not necessarily a render, but can be various process to

build data for a render (such as building a texture from a tiff file, compositing buffers, etc.)

Disabled

Disables the rendering of this layer when true

Type:types.bool
NextTime

Render the render pass next time, whatever its solo and Disable states

Type:types.bool
PassValidity

How should the Pass be scheduled (per frame, per sequence, manually)

Type:types.enum
Solo

Is the Pass in the solo mode ?

If at least one render pass is in the solo mode, only those passes will be computed.

If no render pass are in the solo mode, all the render passes are computed.

type:types.bool
evalfilename(output, eye, frame, side, ext)

Evaluate the output file name of the Pass

The final final of the Pass is evaluated using the given arguments,

such as the name of the output (for Layers), the eye number, the frame number, the side (for CubeMaps and Omni ShadowMaps), and the file extension. If the Pass FileName plug is left blank, then the Pass will pick a default name. This default name is a combination of $l, $o, $e, $f, $s and $x. For instance, a normal Layer, rendered on each frame will have a default file name of $l_$o_$e_$05f.$x Depending on the passed arguments, these $* items will be replaced. If an argument is missing, then matching the value is left as is, and it is the duty of the renderer to correctly replace this value. For instance, leaving the frame as nil will leave any $f as is. Note that $l is always replaced by the Pass path, stripped of any illegal character. Ex: Let’s assume that:

  • the pass raw filename is $l_$o_$05f.$x
  • the pass path is “MyPass”
  • the pass default extension is ‘tiff’

then pass:evalfilename (“MyOutput”, 1, nil) will return MyPass_MyOutput_$05f.tiff

param output:The selected sub output, only for image Layers
type output:str
param eye:The eye number, starting from 1
type eye:number
param frame:The frame number. Use Pass.CurrentFrame to evaluate as the current frame
type frame:number
param side:The cube side number.
type side:number
param ext:The file extension to use.
type ext:str
return:The final renderpass filename
rtype:str
fillrenderpasstemplate(template)

Fill a property sheet template

Parameters:template (table) – The template to fill with the Pass attributes
isrenderable()

Returns true if the render pass will be rendered by the next render command according to the PassValidity, the Disabled and the Solo plugs.

Returns:rendered next time
Return type:bool