RenderSettings(bpy_struct)

base class — bpy_struct

class bpy.types.RenderSettings(bpy_struct)

Rendering settings for a Scene data-block

bake

Type:BakeSettings, (readonly, never None)

bake_bias

Bias towards faces further away from the 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_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

• NORMALS Normals, Bake normals.
• DISPLACEMENT Displacement, Bake displacement.

Type:enum in [‘NORMALS’, ‘DISPLACEMENT’], default ‘NORMALS’

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 region

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

border_max_y

Maximum Y value for the render region

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

border_min_x

Minimum X value for the render region

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

border_min_y

Minimum Y value for the render region

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

display_mode

Select where rendered images will be displayed

• SCREEN Full Screen, Images are rendered in a maximized Image Editor.
• AREA Image Editor, Images are rendered in an Image Editor.
• WINDOW New Window, Images are rendered in a new window.
• NONE Keep User Interface, Images are rendered without changing the user interface.

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

engine

Engine to use for rendering

Type:enum in [‘BLENDER_EEVEE’], default ‘BLENDER_EEVEE’

ffmpeg

FFmpeg related settings for the scene

Type:FFmpegSettings, (readonly)

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)

film_transparent

World background is transparent, for compositing the render over another background

Type:boolean, default False

filter_size

Width over which the reconstruction filter combines samples

Type:float in [0, 500], 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

hair_subdiv

Additional subdivision along the hair

Type:int in [0, 3], default 0

hair_type

Hair shape type

Type:enum in [‘STRAND’, ‘STRIP’], default ‘STRAND’

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)

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_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)

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

preview_pixel_size

Pixel size for viewport rendering

• AUTO Automatic, Automatic pixel size, depends on the user interface scale.
• 1 1x, Render at full resolution.
• 2 2x, Render at 50% resolution.
• 4 4x, Render at 25% resolution.
• 8 8x, Render at 12.5% resolution.

Type:enum in [‘AUTO’, ‘1’, ‘2’, ‘4’, ‘8’], default ‘AUTO’

preview_start_resolution

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

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

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

• WIREFRAME Wireframe, Display the object as wire edges.
• SOLID Solid, Display in solid mode.
• MATERIAL Look Dev, Display in Look Dev mode.
• RENDERED Rendered, Display render preview.

Type:enum in [‘WIREFRAME’, ‘SOLID’, ‘MATERIAL’, ‘RENDERED’], default ‘WIREFRAME’

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_gpencil

Simplify Grease Pencil drawing

Type:boolean, default False

simplify_gpencil_blend

Do not display blend layers

Type:boolean, default False

simplify_gpencil_onplay

Simplify Grease Pencil only during animation playback

Type:boolean, default False

simplify_gpencil_remove_lines

Disable external lines of fill strokes

Type:boolean, default False

simplify_gpencil_shader_fx

Do not apply shader fx

Type:boolean, default False

simplify_gpencil_view_fill

Disable fill strokes in the viewport

Type:boolean, default False

simplify_gpencil_view_modifier

Do not apply modifiers in the viewport

Type:boolean, default False

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_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_selected_to_active

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

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 render region, within the frame size

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 render region size

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_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_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_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_override_scene_strip

Use workbench render settings from the sequencer scene, instead of each individual scene used in the strip

Type:boolean, default False

use_simplify

Enable simplification of scene for quicker preview renders

Type:boolean, default False

use_simplify_smoke_highres

Display high-resolution smoke in the viewport

Type:boolean, default False

use_single_layer

Only render the active layer. Only affects rendering from the interface, ignored for rendering from command line

Type:boolean, default False

use_spherical_stereo

Active render engine supports spherical stereo rendering

Type:boolean, default False, (readonly)

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/video metadata

Type:boolean, default False

use_stamp_filename

Include the .blend filename in image/video metadata

Type:boolean, default False

use_stamp_frame

Include the frame number in image metadata

Type:boolean, default False

use_stamp_frame_range

Include the rendered frame range in image/video metadata

Type:boolean, default False

use_stamp_hostname

Include the hostname of the machine that rendered the frame

Type:boolean, default False

use_stamp_labels

Display 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/video 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/video 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

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)

classmethod bl_rna_get_subclass(id, default=None)

Parameters:id (string) – The RNA type identifier. Returns:The RNA type or default when not found. Return type:bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters:id (string) – The RNA type identifier. Returns:The class or default when not found. Return type:type

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values

References

RenderEngine.render

Scene.render