Skip to content

Scripting API

Render

from ArtisanPlugin.Scripting import RenderApi as render, RenderStudioApi as studio

Document-side rendering: everything on these pages changes the Rhino document or drives Rhino’s own renderer. The live web viewer is a separate surface with its own facade — see Realtime Render.

Which surface do you want?

Realtime RenderRender Studio (this section)
What it isAn external live viewer window you drive interactivelyAn offline photoreal renderer
OutputScreenshots, multi-view sets and video of the live windowRendered image files and turntable MP4s
Touches the documentNeverYes — materials, render settings
Use it forQuick looks, client previews, material try-ons, product shotsFinal imagery

Batch render is separate again: it walks a folder of .3dm files and renders each one unattended.

Materials come in two sets

Design materials and Render materials are two halves of one switch — the flat working look you model in, and the photoreal look you render. Flip to render materials before rendering, and back afterwards if you want the viewport readable again.

Render Studio’s materials are a third, separate catalog — see Studio catalogs for how to discover the exact names it accepts.

Conventions

0 keeps the tool default for Render Studio resolutions and sample counts — but not across the rest of this facade: batch render’s width/height must be a real size, and the staging helpers take literal millimetres and degrees. Everything on these pages changes object materials, adds geometry or writes render settings, so it mutates the document — wrap it in a Transaction when you want one-step undo.