RenderSettings(bpy_struct)

base class — bpy_struct

class bpy.types.RenderSettings(bpy_struct)

Rendering settings for a Scene data-block

alpha_mode

Representation of alpha information in the RGBA pixels

  • SKY Sky, Transparent pixels are filled with sky color.
  • TRANSPARENT Transparent, World background is transparent with premultiplied alpha.
Type:enum in [‘SKY’, ‘TRANSPARENT’], default ‘SKY’
antialiasing_samples

Amount of anti-aliasing samples per pixel

Type:enum in [‘5’, ‘8’, ‘11’, ‘16’], default ‘5’
bake
Type:BakeSettings, (readonly, never None)
bake_aa_mode
Type:enum in [‘5’, ‘8’, ‘11’, ‘16’], default ‘5’
bake_bias

Bias towards faces further away from the object (in blender units)

Type:float in [0, 1000], default 0.0
bake_distance

Maximum distance from active object to other object (in blender units)

Type:float in [0, 1000], default 0.0
bake_margin

Extends the baked result as a post process filter

Type:int in [0, 64], default 0
bake_normal_space

Choose normal space for baking

  • CAMERA Camera, Bake the normals in camera space.
  • WORLD World, Bake the normals in world space.
  • OBJECT Object, Bake the normals in object space.
  • TANGENT Tangent, Bake the normals in tangent space.
Type:enum in [‘CAMERA’, ‘WORLD’, ‘OBJECT’, ‘TANGENT’], default ‘CAMERA’
bake_quad_split

Choose the method used to split a quad into 2 triangles for baking

  • AUTO Automatic, Split quads to give the least distortion while baking.
  • FIXED Fixed, Split quads predictably (0,1,2) (0,2,3).
  • FIXED_ALT Fixed Alternate, Split quads predictably (1,2,3) (1,3,0).
Type:enum in [‘AUTO’, ‘FIXED’, ‘FIXED_ALT’], default ‘AUTO’
bake_samples

Number of samples used for ambient occlusion baking from multires

Type:int in [64, 1024], default 256
bake_type

Choose shading information to bake into the image

  • FULL Full Render, Bake everything.
  • AO Ambient Occlusion, Bake ambient occlusion.
  • SHADOW Shadow, Bake shadows.
  • NORMALS Normals, Bake normals.
  • TEXTURE Textures, Bake textures.
  • DISPLACEMENT Displacement, Bake displacement.
  • DERIVATIVE Derivative, Bake derivative map.
  • VERTEX_COLORS Vertex Colors, Bake vertex colors.
  • EMIT Emission, Bake Emit values (glow).
  • ALPHA Alpha, Bake Alpha values (transparency).
  • MIRROR_INTENSITY Mirror Intensity, Bake Mirror values.
  • MIRROR_COLOR Mirror Colors, Bake Mirror colors.
  • SPEC_INTENSITY Specular Intensity, Bake Specular values.
  • SPEC_COLOR Specular Colors, Bake Specular colors.
Type:enum in [‘FULL’, ‘AO’, ‘SHADOW’, ‘NORMALS’, ‘TEXTURE’, ‘DISPLACEMENT’, ‘DERIVATIVE’, ‘VERTEX_COLORS’, ‘EMIT’, ‘ALPHA’, ‘MIRROR_INTENSITY’, ‘MIRROR_COLOR’, ‘SPEC_INTENSITY’, ‘SPEC_COLOR’], default ‘FULL’
bake_user_scale

Instead of automatically normalizing to 0..1, apply a user scale to the derivative map

Type:float in [0, 1000], default 0.0
border_max_x

Maximum X value for the render border

Type:float in [0, 1], default 0.0
border_max_y

Maximum Y value for the render border

Type:float in [0, 1], default 0.0
border_min_x

Minimum X value for the render border

Type:float in [0, 1], default 0.0
border_min_y

Minimum Y value for the render border

Type:float in [0, 1], default 0.0
display_mode

Select where rendered images will be displayed

  • SCREEN Full Screen, Images are rendered in full Screen.
  • AREA Image Editor, Images are rendered in Image Editor.
  • WINDOW New Window, Images are rendered in new Window.
  • NONE Keep UI, Images are rendered without forcing UI changes.
Type:enum in [‘SCREEN’, ‘AREA’, ‘WINDOW’, ‘NONE’], default ‘SCREEN’
dither_intensity

Amount of dithering noise added to the rendered image to break up banding

Type:float in [0, 2], default 0.0
edge_color

Edge color

Type:float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
edge_threshold

Threshold for drawing outlines on geometry edges

Type:int in [0, 255], default 0
engine

Engine to use for rendering

  • BLENDER_RENDER Blender Render, Use the Blender internal rendering engine for rendering.
Type:enum in [‘BLENDER_RENDER’], default ‘BLENDER_RENDER’
ffmpeg

FFmpeg related settings for the scene

Type:FFmpegSettings, (readonly)
field_order

Order of video fields (select which lines get rendered first, to create smooth motion for TV output)

  • EVEN_FIRST Upper First, Upper field first.
  • ODD_FIRST Lower First, Lower field first.
Type:enum in [‘EVEN_FIRST’, ‘ODD_FIRST’], default ‘EVEN_FIRST’
file_extension

The file extension used for saving renders

Type:string, default “”, (readonly, never None)
filepath

Directory/name to save animations, # characters defines the position and length of frame numbers

Type:string, default “”, (never None)
filter_size

Width over which the reconstruction filter combines samples

Type:float in [0.5, 1.5], default 0.0
fps

Framerate, expressed in frames per second

Type:int in [1, 32767], default 0
fps_base

Framerate base

Type:float in [1e-05, 1e+06], default 0.0
frame_map_new

How many frames the Map Old will last

Type:int in [1, 900], default 0
frame_map_old

Old mapping value in frames

Type:int in [1, 900], default 0
has_multiple_engines

More than one rendering engine is available

Type:boolean, default False, (readonly)
image_settings
Type:ImageFormatSettings, (readonly, never None)
is_movie_format

When true the format is a movie

Type:boolean, default False, (readonly)
layers
Type:RenderLayers bpy_prop_collection of SceneRenderLayer, (readonly)
line_thickness

Line thickness in pixels

Type:float in [0, 10000], default 0.0
line_thickness_mode

Line thickness mode for Freestyle line drawing

  • ABSOLUTE Absolute, Specify unit line thickness in pixels.
  • RELATIVE Relative, Unit line thickness is scaled by the proportion of the present vertical image resolution to 480 pixels.
Type:enum in [‘ABSOLUTE’, ‘RELATIVE’], default ‘ABSOLUTE’
motion_blur_samples

Number of scene samples to take with motion blur

Type:int in [1, 32], default 0
motion_blur_shutter

Time taken in frames between shutter open and close

Type:float in [0, inf], default 0.0
motion_blur_shutter_curve

Curve defining the shutter’s openness over time

Type:CurveMapping, (readonly)
octree_resolution

Resolution of raytrace accelerator, use higher resolutions for larger scenes

Type:enum in [‘64’, ‘128’, ‘256’, ‘512’], default ‘64’
pixel_aspect_x

Horizontal aspect ratio - for anamorphic or non-square pixel output

Type:float in [1, 200], default 0.0
pixel_aspect_y

Vertical aspect ratio - for anamorphic or non-square pixel output

Type:float in [1, 200], default 0.0
pixel_filter_type

Reconstruction filter used for combining anti-aliasing samples

  • BOX Box, Use a box filter for anti-aliasing.
  • TENT Tent, Use a tent filter for anti-aliasing.
  • QUADRATIC Quadratic, Use a quadratic filter for anti-aliasing.
  • CUBIC Cubic, Use a cubic filter for anti-aliasing.
  • CATMULLROM Catmull-Rom, Use a Catmull-Rom filter for anti-aliasing.
  • GAUSSIAN Gaussian, Use a Gaussian filter for anti-aliasing.
  • MITCHELL Mitchell-Netravali, Use a Mitchell-Netravali filter for anti-aliasing.
Type:enum in [‘BOX’, ‘TENT’, ‘QUADRATIC’, ‘CUBIC’, ‘CATMULLROM’, ‘GAUSSIAN’, ‘MITCHELL’], default ‘BOX’
preview_start_resolution

Resolution to start rendering preview at, progressively increasing it to the full viewport size

Type:int in [8, 16384], default 64
raytrace_method

Type of raytrace accelerator structure

  • AUTO Auto, Automatically select acceleration structure.
  • OCTREE Octree, Use old Octree structure.
  • VBVH vBVH, Use vBVH.
  • SIMD_SVBVH SIMD SVBVH, Use SIMD SVBVH.
  • SIMD_QBVH SIMD QBVH, Use SIMD QBVH.
Type:enum in [‘AUTO’, ‘OCTREE’, ‘VBVH’, ‘SIMD_SVBVH’, ‘SIMD_QBVH’], default ‘AUTO’
resolution_percentage

Percentage scale for render resolution

Type:int in [1, 32767], default 0
resolution_x

Number of horizontal pixels in the rendered image

Type:int in [4, 65536], default 0
resolution_y

Number of vertical pixels in the rendered image

Type:int in [4, 65536], default 0
sequencer_gl_preview

Method to draw in the sequencer view

  • BOUNDBOX Bounding Box, Display the object’s local bounding boxes only.
  • WIREFRAME Wireframe, Display the object as wire edges.
  • SOLID Solid, Display the object solid, lit with default OpenGL lights.
  • TEXTURED Texture, Display the object solid, with a texture.
  • MATERIAL Material, Display objects solid, with GLSL material.
  • RENDERED Rendered, Display render preview.
Type:enum in [‘BOUNDBOX’, ‘WIREFRAME’, ‘SOLID’, ‘TEXTURED’, ‘MATERIAL’, ‘RENDERED’], default ‘BOUNDBOX’
simplify_ao_sss

Global approximate AO and SSS quality factor

Type:float in [0, 1], default 0.0
simplify_child_particles

Global child particles percentage

Type:float in [0, 1], default 0.0
simplify_child_particles_render

Global child particles percentage during rendering

Type:float in [0, 1], default 0.0
simplify_shadow_samples

Global maximum shadow samples

Type:int in [0, 32767], default 0
simplify_subdivision

Global maximum subdivision level

Type:int in [0, 32767], default 0
simplify_subdivision_render

Global maximum subdivision level during rendering

Type:int in [0, 32767], default 0
stamp_background

Color to use behind stamp text

Type:float array of 4 items in [0, 1], default (0.0, 0.0, 0.0, 0.0)
stamp_font_size

Size of the font used when rendering stamp text

Type:int in [8, 64], default 0
stamp_foreground

Color to use for stamp text

Type:float array of 4 items in [0, 1], default (0.0, 0.0, 0.0, 0.0)
stamp_note_text

Custom text to appear in the stamp note

Type:string, default “”, (never None)
stereo_views
Type:bpy_prop_collection of SceneRenderView, (readonly)
threads

Number of CPU threads to use simultaneously while rendering (for multi-core/CPU systems)

Type:int in [1, 1024], default 0
threads_mode

Determine the amount of render threads used

  • AUTO Auto-detect, Automatically determine the number of threads, based on CPUs.
  • FIXED Fixed, Manually determine the number of threads.
Type:enum in [‘AUTO’, ‘FIXED’], default ‘AUTO’
tile_x

Horizontal tile size to use while rendering

Type:int in [8, 65536], default 0
tile_y

Vertical tile size to use while rendering

Type:int in [8, 65536], default 0
use_antialiasing

Render and combine multiple samples per pixel to prevent jagged edges

Type:boolean, default False
use_bake_antialiasing

Enables Anti-aliasing

Type:boolean, default False
use_bake_clear

Clear Images before baking

Type:boolean, default False
use_bake_lores_mesh

Calculate heights against unsubdivided low resolution mesh

Type:boolean, default False
use_bake_multires

Bake directly from multires object

Type:boolean, default False
use_bake_normalize

With displacement normalize to the distance, with ambient occlusion normalize without using material settings

Type:boolean, default False
use_bake_selected_to_active

Bake shading on the surface of selected objects to the active object

Type:boolean, default False
use_bake_to_vertex_color

Bake to vertex colors instead of to a UV-mapped image

Type:boolean, default False
use_bake_user_scale

Use a user scale for the derivative map

Type:boolean, default False
use_border

Render a user-defined border region, within the frame size (note that this disables save_buffers and full_sample)

Type:boolean, default False
use_compositing

Process the render result through the compositing pipeline, if compositing nodes are enabled

Type:boolean, default False
use_crop_to_border

Crop the rendered frame to the defined border size

Type:boolean, default False
use_edge_enhance

Create a toon outline around the edges of geometry

Type:boolean, default False
use_envmaps

Calculate environment maps while rendering

Type:boolean, default False
use_fields

Render image to two fields per frame, for interlaced TV output

Type:boolean, default False
use_fields_still

Disable the time difference between fields

Type:boolean, default False
use_file_extension

Add the file format extensions to the rendered file name (eg: filename + .jpg)

Type:boolean, default False
use_free_image_textures

Free all image textures from memory after render, to save memory before compositing

Type:boolean, default False
use_freestyle

Draw stylized strokes using Freestyle

Type:boolean, default False
use_full_sample

Save for every anti-aliasing sample the entire RenderLayer results (this solves anti-aliasing issues with compositing)

Type:boolean, default False
use_game_engine

Current rendering engine is a game engine

Type:boolean, default False, (readonly)
use_instances

Instance support leads to effective memory reduction when using duplicates

Type:boolean, default False
use_local_coords

Vertex coordinates are stored locally on each primitive (increases memory usage, but may have impact on speed)

Type:boolean, default False
use_lock_interface

Lock interface during rendering in favor of giving more memory to the renderer

Type:boolean, default False
use_motion_blur

Use multi-sampled 3D scene motion blur

Type:boolean, default False
use_multiview

Use multiple views in the scene

Type:boolean, default False
use_overwrite

Overwrite existing files while rendering

Type:boolean, default False
use_persistent_data

Keep render data around for faster re-renders

Type:boolean, default False
use_placeholder

Create empty placeholder files while rendering frames (similar to Unix ‘touch’)

Type:boolean, default False
use_raytrace

Pre-calculate the raytrace accelerator and render raytracing effects

Type:boolean, default False
use_render_cache

Save render cache to EXR files (useful for heavy compositing, Note: affects indirectly rendered scenes)

Type:boolean, default False
use_save_buffers

Save tiles for all RenderLayers and SceneNodes to files in the temp directory (saves memory, required for Full Sample)

Type:boolean, default False
use_sequencer

Process the render (and composited) result through the video sequence editor pipeline, if sequencer strips exist

Type:boolean, default False
use_sequencer_gl_textured_solid

Draw face-assigned textures in solid draw method

Type:boolean, default False
use_shading_nodes

Active render engine uses new shading nodes system

Type:boolean, default False, (readonly)
use_shadows

Calculate shadows while rendering

Type:boolean, default False
use_simplify

Enable simplification of scene for quicker preview renders

Type:boolean, default False
use_simplify_triangulate

Disable non-planar quads being triangulated

Type:boolean, default False
use_single_layer

Only render the active layer

Type:boolean, default False
use_spherical_stereo

Active render engine supports spherical stereo rendering

Type:boolean, default False, (readonly)
use_sss

Calculate sub-surface scattering in materials rendering

Type:boolean, default False
use_stamp

Render the stamp info text in the rendered image

Type:boolean, default False
use_stamp_camera

Include the name of the active camera in image metadata

Type:boolean, default False
use_stamp_date

Include the current date in image metadata

Type:boolean, default False
use_stamp_filename

Include the .blend filename in image metadata

Type:boolean, default False
use_stamp_frame

Include the frame number in image metadata

Type:boolean, default False
use_stamp_labels

Draw stamp labels (“Camera” in front of camera name, etc.)

Type:boolean, default False
use_stamp_lens

Include the active camera’s lens in image metadata

Type:boolean, default False
use_stamp_marker

Include the name of the last marker in image metadata

Type:boolean, default False
use_stamp_memory

Include the peak memory usage in image metadata

Type:boolean, default False
use_stamp_note

Include a custom note in image metadata

Type:boolean, default False
use_stamp_render_time

Include the render time in image metadata

Type:boolean, default False
use_stamp_scene

Include the name of the active scene in image metadata

Type:boolean, default False
use_stamp_sequencer_strip

Include the name of the foreground sequence strip in image metadata

Type:boolean, default False
use_stamp_strip_meta

Use metadata from the strips in the sequencer

Type:boolean, default False
use_stamp_time

Include the rendered frame timecode as HH:MM:SS.FF in image metadata

Type:boolean, default False
use_textures

Use textures to affect material properties

Type:boolean, default False
use_world_space_shading

Use world space interpretation of lighting data for node materials

Type:boolean, default False
views
Type:RenderViews bpy_prop_collection of SceneRenderView, (readonly)
views_format
  • STEREO_3D Stereo 3D, Single stereo camera system, adjust the stereo settings in the camera panel.
  • MULTIVIEW Multi-View, Multi camera system, adjust the cameras individually.
Type:enum in [‘STEREO_3D’, ‘MULTIVIEW’], default ‘STEREO_3D’
frame_path(frame=-2147483648, preview=False, view="")

Return the absolute path to the filename to be written for a given frame

Parameters:
  • frame (int in [-inf, inf], (optional)) – Frame number to use, if unset the current frame will be used
  • preview (boolean, (optional)) – Preview, Use preview range
  • view (string, (optional, never None)) – View, The name of the view to use to replace the “%” chars
Returns:

File Path, The resulting filepath from the scenes render settings

Return type:

string, (never None)

Inherited Properties

Inherited Functions

References