render_final
Render a Blender scene to an image file using its lights, materials, and camera, then show the picture for review.
Instructions
Render the scene to a file with its own lights, materials and camera, and show the picture. Needs a camera:
call set_camera first (or pass camera). For quick check pictures use render_sheet (overview) or render_view (any
angle, no set-up). path is absolute, or relative to the work folder; the folder is created.
engine: eevee (fast), cycles (slow, CPU, real light), workbench (flat preview, no lights needed).
size is pixels for a square, or [width, height]. samples is the quality: 16-64 for eevee, 32-256 for cycles.
transparent writes alpha (PNG, WEBP, TIFF, OPEN_EXR) and hides the world. denoise is for cycles only.
view_transform: Standard keeps colours true; Filmic, AgX or Khronos PBR Neutral if the Blender build has them.
exposure is in stops for this render only (+1 doubles the light); without it the scene exposure (set_post) is used.
auto_exposure=true first renders a small probe and picks the exposure that puts the median luminance of the
geometry at mid grey; the answer has auto_exposure. meter is a list of object names (with children) to
measure instead of all geometry: give the model, so a floor or backdrop does not steer the exposure.
Except for OPEN_EXR the answer has tone numbers of the written picture (0-1): frame and, when the geometry is
known (meter, auto_exposure or transparent), object: median, mean, clipped_highlights and crushed_blacks.
warnings appears when over 10% is clipped or over 50% is black. Read these numbers before you trust the
picture. The scene settings are restored afterwards.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| size | No | ||
| meter | No | ||
| camera | No | ||
| engine | No | eevee | |
| denoise | No | ||
| samples | No | ||
| exposure | No | ||
| file_format | No | PNG | |
| transparent | No | ||
| auto_exposure | No | ||
| view_transform | No | Standard |