Skip to content

Latest commit

 

History

History
executable file
·
121 lines (78 loc) · 8.16 KB

index.md

File metadata and controls

executable file
·
121 lines (78 loc) · 8.16 KB

blender_library

blender_library(name, srcs)

Group .blend files and images together to be used as deps in blender_render.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs List of blend files and image files List of labels required

blender_render

blender_render(name, batch_render, blend_file, blender_executable, deps,
               enable_cycles_devices_script, frame_end, frame_start, python_script_args,
               python_scripts, render_engine, render_format, scene)

Render a .blend file in to a list of frames

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
batch_render Number of frames to render at a time. If 0 all the frames will be rendered at once. Integer optional 0
blend_file Blend file to render Label required
blender_executable Blender executable to use for the render. Label optional @blender//:blender
deps blender_library dependencies List of labels optional []
enable_cycles_devices_script - Label optional @blender//:enable_cycles_devices.py
frame_end End frame in animation Integer required
frame_start Start frame in animation Integer required
python_script_args Arguments to pass to blender after '--'. Typically handled by the script the python_script attribute. List of strings optional []
python_scripts Python scripts to run right before render begins List of labels optional []
render_engine Render engine to use. If "UNSET" then the render engine set in the blend file is used. String optional "UNSET"
render_format Render format. See blender documentation String required
scene Scene to render. If not set the default scene in the blend file is used. String optional ""

blender_script

blender_script(name, autoexec_scripts, blend_file, blender_executable, outs, python_script,
               python_script_args, scene)

Run a python script in blender on a specific blend file to get an output

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
autoexec_scripts Enable automatic Python script execution Boolean optional False
blend_file Blend file to run the script on Label required
blender_executable Blender executable to use Label optional @blender//:blender
outs Output files the python_script writes to. These get passed to in format -o path/to/output/file List of labels required
python_script Python script to run Label optional None
python_script_args Arguments to pass to blender after '--' and the built in -o arguments List of strings optional []
scene Scene to set before running python script (optional) String optional ""

blender_test

blender_test(name, autoexec_scripts, blend_file, blender_executable, data, python_script,
             python_script_args, scene)

Run a python script in blender on a specific blend file as a test

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
autoexec_scripts Enable automatic Python script execution Boolean optional False
blend_file Blend file to run the script on Label required
blender_executable Blender executable to use Label optional @blender//:blender
data - List of labels optional []
python_script Python script to run Label optional None
python_script_args Arguments to pass to blender after '--' List of strings optional []
scene Scene to set before running python script (optional) String optional ""

BlenderLibraryInfo

BlenderLibraryInfo()

FIELDS