Navigation

RenderSettings(bpy_struct)

base class — bpy_struct

class bpy.types.RenderSettings(bpy_struct)

Rendering settings for a Scene datablock

alpha_mode

Representation of alpha information in the RGBA pixels

Type :enum in [‘SKY’, ‘PREMUL’, ‘STRAIGHT’], default ‘SKY’
antialiasing_samples

Amount of anti-aliasing samples per pixel

Type :enum in [‘5’, ‘8’, ‘11’, ‘16’], default ‘5’
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

Amount of pixels to extend the baked result with, as post process filter

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

Choose normal space for baking

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

Type :enum in [‘AUTO’, ‘FIXED’, ‘FIXED_ALT’], default ‘AUTO’
bake_type

Choose shading information to bake into the image

Type :enum in [‘FULL’, ‘AO’, ‘SHADOW’, ‘NORMALS’, ‘TEXTURE’, ‘DISPLACEMENT’], default ‘FULL’
border_max_x

Sets maximum X value for the render border

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

Sets maximum Y value for the render border

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

Sets minimum X value to for the render border

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

Sets minimum Y value for the render border

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

Log conversion reference blackpoint

Type :int in [0, 1024], default 0
cineon_gamma

Log conversion gamma

Type :float in [0, 10], default 0.0
cineon_white

Log conversion reference whitepoint

Type :int in [0, 1024], default 0
color_mode

Choose BW for saving greyscale images, RGB for saving red, green and blue channels, AND RGBA for saving red, green, blue + alpha channels

Type :enum in [‘BW’, ‘RGB’, ‘RGBA’], default ‘BW’
display_mode

Select where rendered images will be displayed

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
Type :float array of 3 items in [-inf, 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

Type :enum in [‘BLENDER_RENDER’], default ‘BLENDER_RENDER’
exr_codec

Codec settings for OpenEXR

Type :enum in [‘NONE’, ‘PXR24’, ‘ZIP’, ‘PIZ’, ‘RLE’], default ‘NONE’
exr_preview

When rendering animations, save JPG preview images in same directory

Type :boolean, default False
exr_zbuf

Save the z-depth per pixel (32 bit unsigned int z-buffer)

Type :boolean, default False
ffmpeg_audio_bitrate

Audio bitrate(kb/s)

Type :int in [32, 384], default 0
ffmpeg_audio_codec

FFMpeg audio codec to use

Type :enum in [‘NONE’, ‘MP2’, ‘MP3’, ‘AC3’, ‘AAC’, ‘VORBIS’, ‘FLAC’, ‘PCM’], default ‘NONE’
ffmpeg_audio_mixrate

Audio samplerate(samples/s)

Type :int in [8000, 192000], default 0
ffmpeg_audio_volume

Audio volume

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

Autosplit output at 2GB boundary

Type :boolean, default False
ffmpeg_buffersize

Rate control: buffer size (kb)

Type :int in [0, 2000], default 0
ffmpeg_codec

FFMpeg codec to use

Type :enum in [‘NONE’, ‘MPEG1’, ‘MPEG2’, ‘MPEG4’, ‘HUFFYUV’, ‘DV’, ‘H264’, ‘XVID’, ‘THEORA’, ‘FLASH’, ‘FFV1’], default ‘NONE’
ffmpeg_format

Output file format

Type :enum in [‘MPEG1’, ‘MPEG2’, ‘MPEG4’, ‘AVI’, ‘QUICKTIME’, ‘DV’, ‘H264’, ‘XVID’, ‘OGG’, ‘MKV’, ‘FLASH’, ‘WAV’, ‘MP3’], default ‘MPEG1’
ffmpeg_gopsize

Distance between key frames

Type :int in [0, 100], default 0
ffmpeg_maxrate

Rate control: max rate(kb/s)

Type :int in [1, 14000], default 0
ffmpeg_minrate

Rate control: min rate(kb/s)

Type :int in [0, 9000], default 0
ffmpeg_muxrate

Mux rate (bits/s(!))

Type :int in [0, inf], default 0
ffmpeg_packetsize

Mux packet size (byte)

Type :int in [0, 16384], default 0
ffmpeg_video_bitrate

Video bitrate(kb/s)

Type :int in [1, 14000], default 0
field_order

Order of video fields. Select which lines get rendered first, to create smooth motion for TV output

Type :enum in [‘EVEN_FIRST’, ‘ODD_FIRST’], default ‘EVEN_FIRST’
file_extension

The file extension used for saving renders

Type :string, default “”, (readonly)
file_format

File format to save the rendered images as

Type :enum in [‘BMP’, ‘IRIS’, ‘PNG’, ‘JPEG’, ‘JPEG2000’, ‘TARGA’, ‘TARGA_RAW’, ‘CINEON’, ‘DPX’, ‘MULTILAYER’, ‘OPEN_EXR’, ‘HDR’, ‘TIFF’, ‘AVI_JPEG’, ‘AVI_RAW’, ‘FRAMESERVER’, ‘H264’, ‘FFMPEG’, ‘THEORA’, ‘XVID’], default ‘TARGA’
file_quality

Quality of JPEG images, AVI Jpeg and SGI movies, Compression for PNG’s

Type :int in [0, 100], default 0
filepath

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

Type :string, default “”
filter_size

Pixel 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, 120], default 0
fps_base

Framerate base

Type :float in [0.1, 120], default 0.0
frame_map_new

Specify how many frames the Map Old will last

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

Specify 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)
is_movie_format

When true the format is a movie

Type :boolean, default False, (readonly)
jpeg2k_depth

Bit depth per channel

Type :enum in [‘8’, ‘12’, ‘16’], default ‘8’
jpeg2k_preset

Use a DCI Standard preset for saving jpeg2000

Type :enum in [‘NO_PRESET’, ‘CINE_24FPS’, ‘CINE_48FPS’, ‘CINE_24FPS_4K’, ‘CINE_SCOPE_24FPS’, ‘CINE_SCOPE_48FPS’, ‘CINE_FLAT_24FPS’, ‘CINE_FLAT_48FPS’], default ‘NO_PRESET’
jpeg2k_ycc

Save luminance-chrominance-chrominance channels instead of RGB colors

Type :boolean, default False
layers
Type :RenderLayers bpy_prop_collection of SceneRenderLayer, (readonly)
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.01, 10], default 0.0
octree_resolution

Resolution of raytrace accelerator. Use higher resolutions for larger scenes

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

Number of horizontal tiles to use while rendering

Type :int in [1, 512], default 0
parts_y

Number of vertical tiles to use while rendering

Type :int in [1, 512], default 0
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

Type :enum in [‘BOX’, ‘TENT’, ‘QUADRATIC’, ‘CUBIC’, ‘CATMULLROM’, ‘GAUSSIAN’, ‘MITCHELL’], default ‘BOX’
raytrace_method

Type of raytrace accelerator structure

Type :enum in [‘AUTO’, ‘OCTREE’, ‘BLIBVH’, ‘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, 10000], default 0
resolution_y

Number of vertical pixels in the rendered image

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

Method to draw in the sequencer view

Type :enum in [‘BOUNDBOX’, ‘WIREFRAME’, ‘SOLID’, ‘TEXTURED’], default ‘BOUNDBOX’
sequencer_gl_render

Method to draw in the sequencer view

Type :enum in [‘BOUNDBOX’, ‘WIREFRAME’, ‘SOLID’, ‘TEXTURED’], default ‘BOUNDBOX’
simplify_ao_sss

Global approximate AA 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_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
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 “”
threads

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

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

Determine the amount of render threads used

Type :enum in [‘AUTO’, ‘FIXED’], default ‘AUTO’
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_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_border

Render a user-defined border region, within the frame size. Note, this disables save_buffers and full_sample

Type :boolean, default False
use_cineon_log

Convert to logarithmic color space

Type :boolean, default False
use_color_management

Use linear workflow - gamma corrected imaging pipeline

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_exr_half

Use 16 bit floats instead of 32 bit floats per channel

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 texture from memory after render, to save memory before compositing

Type :boolean, default False
use_free_unused_nodes

Free Nodes that are not used while compositing, to save memory

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 localy on each primitive. Increases memory usage, but may have impact on speed

Type :boolean, default False
use_motion_blur

Use multi-sampled 3D scene motion blur

Type :boolean, default False
use_overwrite

Overwrite existing files while rendering

Type :boolean, default False
use_placeholder

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

Type :boolean, default False
use_radiosity

Calculate radiosity in a pre-process before rendering

Type :boolean, default False
use_raytrace

Pre-calculate the raytrace accelerator and render raytracing effects

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_preview
Type :boolean, default False
use_sequencer_gl_render
Type :boolean, default False
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

Disables non-planer quads being triangulated

Type :boolean, default False
use_single_layer

Only render the active layer

Type :boolean, default False
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 filename of the .blend file in image metadata

Type :boolean, default False
use_stamp_frame

Include the frame number in image metadata

Type :boolean, default False
use_stamp_lens

Include the name of the active cameras 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_note

Include a custom note in image metadata

Type :boolean, default False
use_stamp_render_time

Include the render time in the stamp image

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_time

Include the render frame 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_tiff_16bit

Save TIFF with 16 bits per channel

Type :boolean, default False
frame_path(frame=-2147483648)

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.
Returns:File Path, the resulting filepath from the scenes render settings.
Return type:string

Inherited Properties

Inherited Functions

References

Previous topic

RenderResult(bpy_struct)

Next topic

RigidBodyJointConstraint(Constraint)

© Copyright Blender Foundation. Created using Sphinx 1.0.7.