CyclesRenderSettings(bpy_struct)

base class — bpy_struct

class bpy.types.CyclesRenderSettings(bpy_struct)
aa_samples

Number of antialiasing samples to render for each pixel

Type:int in [1, 2097151], default 128
ao_bounces

Approximate indirect light with background tinted ambient occlusion at the specified bounce, 0 disables this feature

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

Approximate indirect light with background tinted ambient occlusion at the specified bounce, 0 disables this feature

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

Number of ambient occlusion samples to render for each AA sample

Type:int in [1, 1024], default 1
bake_type

Type of pass to bake

Type:enum in [‘COMBINED’, ‘AO’, ‘SHADOW’, ‘NORMAL’, ‘UV’, ‘ROUGHNESS’, ‘EMIT’, ‘ENVIRONMENT’, ‘DIFFUSE’, ‘GLOSSY’, ‘TRANSMISSION’, ‘SUBSURFACE’], default ‘COMBINED’
blur_glossy

Adaptively blur glossy shaders after blurry bounces, to reduce noise at the cost of accuracy

Type:float in [0, 10], default 1.0
camera_cull_margin

Margin for the camera space culling

Type:float in [0, 5], default 0.1
caustics_reflective

Use reflective caustics, resulting in a brighter image (more noise but added realism)

Type:boolean, default True
caustics_refractive

Use refractive caustics, resulting in a brighter image (more noise but added realism)

Type:boolean, default True
debug_bvh_layout
Type:enum in [‘BVH2’, ‘BVH4’, ‘BVH8’], default ‘BVH8’
debug_bvh_time_steps

Split BVH primitives by this number of time steps to speed up render time in cost of memory

Type:int in [0, 16], default 0
debug_bvh_type

Choose between faster updates, or faster render

  • DYNAMIC_BVH Dynamic BVH, Objects can be individually updated, at the cost of slower render time.
  • STATIC_BVH Static BVH, Any object modification requires a complete BVH rebuild, but renders faster.
Type:enum in [‘DYNAMIC_BVH’, ‘STATIC_BVH’], default ‘DYNAMIC_BVH’
debug_cancel_timeout
Type:float in [0.01, 10], default 0.1
debug_opencl_device_type
Type:enum in [‘NONE’, ‘ALL’, ‘DEFAULT’, ‘CPU’, ‘GPU’, ‘ACCELERATOR’], default ‘ALL’
debug_opencl_kernel_type
Type:enum in [‘DEFAULT’, ‘MEGA’, ‘SPLIT’], default ‘DEFAULT’
debug_opencl_mem_limit

Artificial limit on OpenCL memory usage in MB (0 to disable limit)

Type:int in [-inf, inf], default 0
debug_optix_cuda_streams
Type:int in [1, inf], default 1
debug_reset_timeout
Type:float in [0.01, 10], default 0.1
debug_text_timeout
Type:float in [0.01, 10], default 1.0
debug_tile_size
Type:int in [1, 4096], default 1024
debug_use_cpu_avx
Type:boolean, default True
debug_use_cpu_avx2
Type:boolean, default True
debug_use_cpu_split_kernel
Type:boolean, default False
debug_use_cpu_sse2
Type:boolean, default True
debug_use_cpu_sse3
Type:boolean, default True
debug_use_cpu_sse41
Type:boolean, default True
debug_use_cuda_adaptive_compile
Type:boolean, default False
debug_use_cuda_split_kernel
Type:boolean, default False
debug_use_hair_bvh

Use special type BVH optimized for hair (uses more ram but renders faster)

Type:boolean, default True
debug_use_opencl_debug
Type:boolean, default False
debug_use_spatial_splits

Use BVH spatial splits: longer builder time, faster render

Type:boolean, default False
device

Device to use for rendering

  • CPU CPU, Use CPU for rendering.
  • GPU GPU Compute, Use GPU compute device for rendering, configured in the system tab in the user preferences.
Type:enum in [‘CPU’, ‘GPU’], default ‘CPU’
dicing_camera

Camera to use as reference point when subdividing geometry, useful to avoid crawling artifacts in animations when the scene camera is moving

Type:Object
dicing_rate

Size of a micropolygon in pixels

Type:float in [0.1, 1000], default 1.0
diffuse_bounces

Maximum number of diffuse reflection bounces, bounded by total maximum

Type:int in [0, 1024], default 4
diffuse_samples

Number of diffuse bounce samples to render for each AA sample

Type:int in [1, 1024], default 1
distance_cull_margin

Cull objects which are further away from camera than this distance

Type:float in [0, inf], default 50.0
feature_set

Feature set to use for rendering

  • SUPPORTED Supported, Only use finished and supported features.
  • EXPERIMENTAL Experimental, Use experimental and incomplete features that might be broken or change in the future.
Type:enum in [‘SUPPORTED’, ‘EXPERIMENTAL’], default ‘SUPPORTED’
film_exposure

Image brightness scale

Type:float in [0, 10], default 1.0
film_transparent_glass

Render transmissive surfaces as transparent, for compositing glass over another background

Type:boolean, default False
film_transparent_roughness

For transparent transmission, keep surfaces with roughness above the threshold opaque

Type:float in [0, 1], default 0.1
filter_type

Pixel filter type

  • BOX Box, Box filter.
  • GAUSSIAN Gaussian, Gaussian filter.
  • BLACKMAN_HARRIS Blackman-Harris, Blackman-Harris filter.
Type:enum in [‘BOX’, ‘GAUSSIAN’, ‘BLACKMAN_HARRIS’], default ‘BLACKMAN_HARRIS’
filter_width

Pixel filter width

Type:float in [0.01, 10], default 1.5
glossy_bounces

Maximum number of glossy reflection bounces, bounded by total maximum

Type:int in [0, 1024], default 4
glossy_samples

Number of glossy bounce samples to render for each AA sample

Type:int in [1, 1024], default 1
light_sampling_threshold

Probabilistically terminate light samples when the light contribution is below this threshold (more noise but faster rendering). Zero disables the test and never ignores lights

Type:float in [0, 1], default 0.01
max_bounces

Total maximum number of bounces

Type:int in [0, 1024], default 12
max_subdivisions

Stop subdividing when this level is reached even if the dice rate would produce finer tessellation

Type:int in [0, 16], default 12
mesh_light_samples

Number of mesh emission light samples to render for each AA sample

Type:int in [1, 1024], default 1
min_light_bounces

Minimum number of light bounces. Setting this higher reduces noise in the first bounces, but can also be less efficient for more complex geometry like hair and volumes

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

Minimum number of transparent bounces. Setting this higher reduces noise in the first bounces, but can also be less efficient for more complex geometry like hair and volumes

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

Offset for the shutter’s time interval, allows to change the motion blur trails

  • START Start on Frame, The shutter opens at the current frame.
  • CENTER Center on Frame, The shutter is open during the current frame.
  • END End on Frame, The shutter closes at the current frame.
Type:enum in [‘START’, ‘CENTER’, ‘END’], default ‘CENTER’
offscreen_dicing_scale

Multiplier for dicing rate of geometry outside of the camera view. The dicing rate of objects is gradually increased the further they are outside the camera view. Lower values provide higher quality reflections and shadows for off screen objects, while higher values use less memory

Type:float in [1, inf], default 4.0
pixel_filter_type

Pixel filter type

  • BOX Box, Box filter.
  • GAUSSIAN Gaussian, Gaussian filter.
  • BLACKMAN_HARRIS Blackman-Harris, Blackman-Harris filter.
Type:enum in [‘BOX’, ‘GAUSSIAN’, ‘BLACKMAN_HARRIS’], default ‘BLACKMAN_HARRIS’
preview_aa_samples

Number of antialiasing samples to render in the viewport, unlimited if 0

Type:int in [0, 2097151], default 32
preview_dicing_rate

Size of a micropolygon in pixels during preview render

Type:float in [0.1, 1000], default 8.0
preview_pause

Pause all viewport preview renders

Type:boolean, default False
preview_samples

Number of samples to render in the viewport, unlimited if 0

Type:int in [0, inf], default 32
preview_start_resolution

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

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

Method to sample lights and materials

  • BRANCHED_PATH Branched Path Tracing, Path tracing integrator that branches on the first bounce, giving more control over the number of light and material samples.
  • PATH Path Tracing, Pure path tracing integrator.
Type:enum in [‘BRANCHED_PATH’, ‘PATH’], default ‘PATH’
rolling_shutter_duration

Scanline “exposure” time for the rolling shutter effect

Type:float in [0, 1], default 0.1
rolling_shutter_type

Type of rolling shutter effect matching CMOS-based cameras

  • NONE None, No rolling shutter effect used.
  • TOP Top-Bottom, Sensor is being scanned from top to bottom.
Type:enum in [‘NONE’, ‘TOP’], default ‘NONE’
sample_all_lights_direct

Sample all lights (for direct samples), rather than randomly picking one

Type:boolean, default True
sample_all_lights_indirect

Sample all lights (for indirect samples), rather than randomly picking one

Type:boolean, default True
sample_clamp_direct

If non-zero, the maximum value for a direct sample, higher values will be scaled down to avoid too much noise and slow convergence at the cost of accuracy

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

If non-zero, the maximum value for an indirect sample, higher values will be scaled down to avoid too much noise and slow convergence at the cost of accuracy

Type:float in [0, inf], default 10.0
samples

Number of samples to render for each pixel

Type:int in [1, inf], default 128
sampling_pattern

Random sampling pattern used by the integrator

  • SOBOL Sobol, Use Sobol random sampling pattern.
  • CORRELATED_MUTI_JITTER Correlated Multi-Jitter, Use Correlated Multi-Jitter random sampling pattern.
Type:enum in [‘SOBOL’, ‘CORRELATED_MUTI_JITTER’], default ‘SOBOL’
seed

Seed value for integrator to get different noise patterns

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

Use Open Shading Language (CPU rendering only)

Type:boolean, default False
subsurface_samples

Number of subsurface scattering samples to render for each AA sample

Type:int in [1, 1024], default 1
texture_limit

Limit texture size used by viewport rendering

  • OFF No Limit, No texture size limit.
  • 128 128, Limit texture size to 128 pixels.
  • 256 256, Limit texture size to 256 pixels.
  • 512 512, Limit texture size to 512 pixels.
  • 1024 1024, Limit texture size to 1024 pixels.
  • 2048 2048, Limit texture size to 2048 pixels.
  • 4096 4096, Limit texture size to 4096 pixels.
  • 8192 8192, Limit texture size to 8192 pixels.
Type:enum in [‘OFF’, ‘128’, ‘256’, ‘512’, ‘1024’, ‘2048’, ‘4096’, ‘8192’], default ‘OFF’
texture_limit_render

Limit texture size used by final rendering

  • OFF No Limit, No texture size limit.
  • 128 128, Limit texture size to 128 pixels.
  • 256 256, Limit texture size to 256 pixels.
  • 512 512, Limit texture size to 512 pixels.
  • 1024 1024, Limit texture size to 1024 pixels.
  • 2048 2048, Limit texture size to 2048 pixels.
  • 4096 4096, Limit texture size to 4096 pixels.
  • 8192 8192, Limit texture size to 8192 pixels.
Type:enum in [‘OFF’, ‘128’, ‘256’, ‘512’, ‘1024’, ‘2048’, ‘4096’, ‘8192’], default ‘OFF’
tile_order

Tile order for rendering

  • CENTER Center, Render from center to the edges.
  • RIGHT_TO_LEFT Right to Left, Render from right to left.
  • LEFT_TO_RIGHT Left to Right, Render from left to right.
  • TOP_TO_BOTTOM Top to Bottom, Render from top to bottom.
  • BOTTOM_TO_TOP Bottom to Top, Render from bottom to top.
  • HILBERT_SPIRAL Hilbert Spiral, Render in a Hilbert Spiral.
Type:enum in [‘CENTER’, ‘RIGHT_TO_LEFT’, ‘LEFT_TO_RIGHT’, ‘TOP_TO_BOTTOM’, ‘BOTTOM_TO_TOP’, ‘HILBERT_SPIRAL’], default ‘HILBERT_SPIRAL’
transmission_bounces

Maximum number of transmission bounces, bounded by total maximum

Type:int in [0, 1024], default 12
transmission_samples

Number of transmission bounce samples to render for each AA sample

Type:int in [1, 1024], default 1
transparent_max_bounces

Maximum number of transparent bounces

Type:int in [0, 1024], default 8
use_animated_seed

Use different seed values (and hence noise patterns) at different frames

Type:boolean, default False
use_bvh_embree

Use Embree as ray accelerator

Type:boolean, default False
use_camera_cull

Allow objects to be culled based on the camera frustum

Type:boolean, default False
use_distance_cull

Allow objects to be culled based on the distance from camera

Type:boolean, default False
use_layer_samples

How to use per view layer sample settings

  • USE Use, Per render layer number of samples override scene samples.
  • BOUNDED Bounded, Bound per render layer number of samples by global samples.
  • IGNORE Ignore, Ignore per render layer number of samples.
Type:enum in [‘USE’, ‘BOUNDED’, ‘IGNORE’], default ‘USE’
use_progressive_refine

Instead of rendering each tile until it is finished, refine the whole image progressively (this renders somewhat slower, but time can be saved by manually stopping the render when the noise is low enough)

Type:boolean, default False
use_square_samples

Square sampling values for easier artist control

Type:boolean, default False
volume_bounces

Maximum number of volumetric scattering events

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

Maximum number of steps through the volume before giving up, to avoid extremely long render times with big objects or small step sizes

Type:int in [2, 65536], default 1024
volume_samples

Number of volume scattering samples to render for each AA sample

Type:int in [1, 1024], default 1
volume_step_size

Distance between volume shader samples when rendering the volume (lower values give more accurate and detailed results, but also increased render time)

Type:float in [1e-07, 100000], default 0.1
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

Inherited Functions