renderoptions

guerilla.renderoptions(opts)

Generate the default set of render options, or fill the missing options

When no argument is given, this function create a table of rendering options

to pass to the render() function. All mandatory options are set to their default value, which can be dependent on the current project settings.

When a table is given, this function fills the table with missing default options. Present options are left unchanged.

The result can be sent to the render function.

This function is documented to provide a useful list of available options, as well as their default value.

NameDescriptionDefault

string Name The name of the jobs to be rendered $(SCENE) – the project file name

string FrameRange The frame range to override empty, use the RenderPass or the time line

{string} Passes The RenderPasses to render All renderable passes

boolean ForceHighQuality Enforce high quality rendering false

string FilePrefix(*) The file name prefix of the render files to be generated Name_

string JobsDirectory The directory to write scripts to $(JOBS)=$(SCENE_PATH)/jobs

string RibsDirectory The directory to write rib files to $(RIBS)=$(SCENE_PATH)/ribs

string RenderId The value to set $(RENDER_ID) The current date-time

boolean CompressedRib Rib files are gz compressed Depends on Render Settings > Compressed Rib

number DistributedCount The number of tiles to split the image Depends on the GUI settings

boolean PreRender Enables a prerendering job to be executed prior to any other job. The prerender job

loads the Guerilla project copy and triggers the “batchprerender” signal.

boolean PostRender Enables a postrendering job to be executed after all other jobs. The postrender job

loads the Guerilla project copy and triggers the “batchpostrender” signal.

boolean DeferredRibGen Defer the rib generation on the farm Depends on the GUI settings

boolean DeferredRibGenBatch The number of Rib frames to generate in a batch when DeferredRibGen is set. Leave to 0 to generate the whole range at once.

string DeferredFile(*) (**) The deferred file to save $(JOBS)/FilePrefixribgen_RenderId.gproject

boolean WriteBackup(**) Write backup projects along with the result frames false

boolean WriteScripts(**) Perform the render script generation true

boolean WriteFrameData(**) Perform the per frame rib generation true

boolean DoSubmit(**) Submit the jobs to the renderfarm true

boolean Log Log information on the console while generating scripts and ribs false

boolean Verbose Log more verbose information on the console while generating scripts and ribs false

(*) The default value of FilePrefix has a ‘_’ character apended at the end.

(**) The DeferredRibGen option will automatically set the WriteScripts, WriteFrameData and DoSubmit options properly. You must not override these values explicitely, or the deferred rib generation may not properly work.

param opts:The render options type opts:table or None