scriptjob¶
-
class
guerilla.scriptjob¶ Bases:
object-
Dependencies¶ List of scriptjob ids this job depends on
This list indicates which other jobs this job depends on. This job must not be executed before all dependencies have been successfully executed.
Returns: script job dependencies Return type: list of int
-
DependencyIn¶ The kind of dependency this job has.
DependencyIn is ‘frame’ for ‘frame’ jobs that only depend on other jobs matching frame. For example, a time independent process that only requires that the same frame was properly rendered in the dependent job has DependencyIn set to ‘frame’.
On the opposite, a process that requires all frames to be rendered to render its batch of frames has DependencyIn set to ‘all’
Returns: input dependency Return type: str
-
Distributed¶ The distributed fraction, as in 1/4 for the first of 4 tiles
Returns: distrubuted fraction, or false if not distributed Return type: str or False
-
FrameRange¶ The scriptjob frame range as a string
Returns: string frame range, as in ‘1:10’ Return type: str
-
Frames¶ The scriptjob frame list
Note that, although ‘pre’ and ‘post’ jobs may have a frame range, it is not relevant. ‘pre’ (resp. ‘post’) jobs should be execute at the first (resp. the last) frame of their range.
Returns: list of frames this job is to be rendered Return type: list of int
-
JobId¶ The scriptjob id This id is the index of the job in the list returned by the render function.
Returns: script job id Return type: int
-
Type¶ The scriptjob type.
Prepass jobs, such as a ribgen are ‘pre’, classic RenderPasses are ‘frame’, and postpass jobs such as movie generation are ‘post’
Returns: script job type Return type: str
-
getcommandargs(frame)¶ Get the scriptjob command line arguments
Parameters: frame (number) – the frame Returns: the scriptjob command line Return type: {string}
-
getcommandline(frame)¶ Get the scriptjob command line as a string
Parameters: frame (number) – the frame Returns: the scriptjob command line Return type: str
-
getscriptargs(frame)¶ Get the scriptjob arguments after the command and script
Parameters: frame (number) – the frame Returns: the scriptjob arguments Return type: {string} or None
-
getscriptcommand(frame)¶ Get the scriptjob executable to run the job
Parameters: frame (number) – the frame Returns: the scriptjob executable command Return type: str
-