Render3DOptions parameters
download : [boolean] (default:
true) Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR.
They are downloaded to a temporal directory and discarded.
If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.move_x : [number] (default:
0) Steps to move in the X axis, positive is to the right. Just like pressing the right arrow in the 3D viewer.move_y : [number] (default:
0) Steps to move in the Y axis, positive is up. Just like pressing the up arrow in the 3D viewer.no_virtual : [boolean] (default:
false) Used to exclude 3D models for components with ‘virtual’ attribute.output : [string] (default:
'%f-%i%I%v.%x') Name for the generated image file (%i=’3D_$VIEW’ %x=’png’). Affected by global options.ray_tracing : [boolean] (default:
false) Enable the ray tracing. Much better result, but slow, and you’ll need to adjust wait_rt.rotate_x : [number] (default:
0) Steps to rotate around the X axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.rotate_y : [number] (default:
0) Steps to rotate around the Y axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.rotate_z : [number] (default:
0) Steps to rotate around the Z axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.show_components : [list(string) | string] (default:
'all') (choices: “none”, “all”) (also accepts any string) List of components to draw, can be also a string for none or all. Ranges like R5-R10 are supported.
Unlike the pcbdraw output, the default is all.view : [string] (default:
'top') (choices: “top”, “bottom”, “front”, “rear”, “right”, “left”, “z”, “Z”, “y”, “Y”, “x”, “X”) Point of view.zoom : [number] (default:
0) Zoom steps. Use positive to enlarge, get closer, and negative to reduce. Same result as using the mouse wheel in the 3D viewer.
Note that KiCad 8 starts with a zoom to fit, so you might not even need it.auto_crop: [boolean] (default:false) When enabled the image will be post-processed to remove the empty space around the image. In this mode the background2 is changed to be the same as background1.background1: [string] (default:'#66667F') First color for the background gradient.background2: [string] (default:'#CCCCE5') Second color for the background gradient.board: [string] (default:'#332B16') Color for the board without copper or solder mask.clip_silk_on_via_annulus: [boolean] (default:true) Clip silkscreen at via annuli (KiCad 6+).copper: [string] (default:'#8b898c') Color for the copper.dnf_filter: [string | list(string)] (default:'_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.download_lcsc: [boolean] (default:true) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you’ll need to provide the LCSC part number. The field containing the LCSC part number is defined by the field_lcsc_part global variable.enable_crop_workaround: [boolean] (default:false) Some versions of Image Magick (i.e. the one in Debian 11) needs two passes to crop. Enable it to force a double pass. It was the default in KiBot 1.7.0 and older.exclude_filter: [string | list(string)] (default:'_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.force_stackup_colors: [boolean] (default:false) Tell KiCad to use the colors from the stackup. They are better than the unified KiBot colors. Needs KiCad 6 or newer.height: [number] (default:720) Image height (aprox.).highlight: [list(string)] (default:[]) List of components to highlight. Ranges like R5-R10 are supported.highlight_on_top: [boolean] (default:false) Highlight over the component (not under).highlight_padding: [number] (default:1.5) (range: 0 to 1000) How much the highlight extends around the component [mm].kicad_3d_url: [string] (default:'https://gitlab.com/api/v4/projects/21604637/repository/files/') Base URL for the KiCad 3D models.kicad_3d_url_suffix: [string] (default:'/raw?ref=VERSION') Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.kicad_3d_url_version: [boolean] (default:true) Replace the master subdir in the URL by the KiCad version. In this way we download the 3D model corresponding to the installed KiCad instead of the last available.no_smd: [boolean] (default:false) Used to exclude 3D models for surface mount components.no_tht: [boolean] (default:false) Used to exclude 3D models for through hole components.orthographic: [boolean] (default:false) Enable the orthographic projection mode (top view looks flat).pre_transform: [string | list(string)] (default:'_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.realistic: [boolean] (default:true) When disabled we use the colors of the layers used by the GUI. Needs KiCad 6 or 7. Is emulated on KiCad 8.show_adhesive: [boolean] (default:false) Show the content of F.Adhesive/B.Adhesive layers. KiCad 6 or newer.show_board_body: [boolean] (default:true) Show the PCB core material. KiCad 6 or newer.show_comments: [boolean] (default:false) Show the content of the User.Comments and User.Drawings layer for KiCad 5, 6 and 7. On KiCad 8 this option controls only the User.Comments and you have a separated option for the User.Drawings called show_drawings Note that KiCad 5/6/7 doesn’t show it when realistic is enabled, but KiCad 8 does it.
Also note that KiCad 5 ray tracer shows comments outside the PCB, but newer KiCad versions doesn’t.show_drawings: [boolean] (default:false) Show the content of the User.Drawings layer. Only available for KiCad 8 and newer. Consult show_comments to learn when drawings are visible.show_eco: [boolean] (default:false) Show the content of the Eco1.User/Eco2.User layers. For KiCad 8 show_eco1 and show_eco2 are available.
Consult show_comments to learn when drawings are visible.show_eco1: [boolean] (default:false) Show the content of the Eco1.User layer. KiCad 8 supports individual Eco layer options, for 6 and 7 use the show_eco option.
Consult show_comments to learn when drawings are visible.show_eco2: [boolean] (default:false) Show the content of the Eco1.User layer. KiCad 8 supports individual Eco layer options, for 6 and 7 use the show_eco option.
Consult show_comments to learn when drawings are visible.show_silkscreen: [boolean] (default:true) Show the silkscreen layers (KiCad 6+).show_soldermask: [boolean] (default:true) Show the solder mask layers (KiCad 6+).show_solderpaste: [boolean] (default:true) Show the solder paste layers (KiCad 6+).show_zones: [boolean] (default:true) Show filled areas in zones (KiCad 6+).silk: [string] (default:'#d5dce4') Color for the silk screen.solder_mask: [string] (default:'#208b47') Color for the solder mask.solder_paste: [string] (default:'#808080') Color for the solder paste.subtract_mask_from_silk: [boolean] (default:true) Clip silkscreen at solder mask edges (KiCad 6+).transparent_background: [boolean] (default:false) When enabled the image will be post-processed to make the background transparent. In this mode the background1 and background2 colors are ignored.transparent_background_color: [string] (default:'#00ff00') Color used for the chroma key. Adjust it if some regions of the board becomes transparent.transparent_background_fuzz: [number] (default:15) (range: 0 to 100) Chroma key tolerance (percent). Bigger values will remove more pixels.variant: [string] (default:'') Board variant to apply.wait_ray_tracing : Alias for wait_render.
wait_render: [number] (default:-600) How many seconds we must wait before capturing the render (ray tracing or normal). Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered.
Use negative values to enable the auto-detect using CPU load.
In this case the value is interpreted as a time-out.
.width: [number] (default:1280) Image width (aprox.).