RenderLayer(bpy_struct)

base class — bpy_struct

class bpy.types.RenderLayer(bpy_struct)

exclude_ambient_occlusion

Exclude AO pass from combined

Type:boolean, default False, (readonly)

exclude_emit

Exclude emission pass from combined

Type:boolean, default False, (readonly)

exclude_environment

Exclude environment pass from combined

Type:boolean, default False, (readonly)

exclude_indirect

Exclude indirect pass from combined

Type:boolean, default False, (readonly)

exclude_reflection

Exclude raytraced reflection pass from combined

Type:boolean, default False, (readonly)

exclude_refraction

Exclude raytraced refraction pass from combined

Type:boolean, default False, (readonly)

exclude_shadow

Exclude shadow pass from combined

Type:boolean, default False, (readonly)

exclude_specular

Exclude specular pass from combined

Type:boolean, default False, (readonly)

invert_zmask

For Zmask, only render what is behind solid z values instead of in front

Type:boolean, default False, (readonly)

layers

Scene layers included in this render layer

Type:boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly)

layers_exclude

Exclude scene layers from having any influence

Type:boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly)

layers_zmask

Zmask scene layers for solid faces

Type:boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly)

light_override

Group to override all other lights in this render layer

Type:Group, (readonly)

material_override

Material to override all other materials in this render layer

Type:Material, (readonly)

name

Render layer name

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

passes

Type:RenderPasses bpy_prop_collection of RenderPass, (readonly)

use

Disable or enable the render layer

Type:boolean, default False, (readonly)

use_all_z

Fill in Z values for solid faces in invisible layers, for masking

Type:boolean, default False, (readonly)

use_ao

Render AO in this Layer

Type:boolean, default False, (readonly)

use_edge_enhance

Render Edge-enhance in this Layer (only works for Solid faces)

Type:boolean, default False, (readonly)

use_freestyle

Render stylized strokes in this Layer

Type:boolean, default False, (readonly)

use_halo

Render Halos in this Layer (on top of Solid)

Type:boolean, default False, (readonly)

use_pass_ambient_occlusion

Deliver AO pass

Type:boolean, default False, (readonly)

use_pass_color

Deliver shade-less color pass

Type:boolean, default False, (readonly)

use_pass_combined

Deliver full combined RGBA buffer

Type:boolean, default False, (readonly)

use_pass_diffuse

Deliver diffuse pass

Type:boolean, default False, (readonly)

use_pass_diffuse_color

Deliver diffuse color pass

Type:boolean, default False, (readonly)

use_pass_diffuse_direct

Deliver diffuse direct pass

Type:boolean, default False, (readonly)

use_pass_diffuse_indirect

Deliver diffuse indirect pass

Type:boolean, default False, (readonly)

use_pass_emit

Deliver emission pass

Type:boolean, default False, (readonly)

use_pass_environment

Deliver environment lighting pass

Type:boolean, default False, (readonly)

use_pass_glossy_color

Deliver glossy color pass

Type:boolean, default False, (readonly)

use_pass_glossy_direct

Deliver glossy direct pass

Type:boolean, default False, (readonly)

use_pass_glossy_indirect

Deliver glossy indirect pass

Type:boolean, default False, (readonly)

use_pass_indirect

Deliver indirect lighting pass

Type:boolean, default False, (readonly)

use_pass_material_index

Deliver material index pass

Type:boolean, default False, (readonly)

use_pass_mist

Deliver mist factor pass (0.0-1.0)

Type:boolean, default False, (readonly)

use_pass_normal

Deliver normal pass

Type:boolean, default False, (readonly)

use_pass_object_index

Deliver object index pass

Type:boolean, default False, (readonly)

use_pass_reflection

Deliver raytraced reflection pass

Type:boolean, default False, (readonly)

use_pass_refraction

Deliver raytraced refraction pass

Type:boolean, default False, (readonly)

use_pass_shadow

Deliver shadow pass

Type:boolean, default False, (readonly)

use_pass_specular

Deliver specular pass

Type:boolean, default False, (readonly)

use_pass_subsurface_color

Deliver subsurface color pass

Type:boolean, default False, (readonly)

use_pass_subsurface_direct

Deliver subsurface direct pass

Type:boolean, default False, (readonly)

use_pass_subsurface_indirect

Deliver subsurface indirect pass

Type:boolean, default False, (readonly)

use_pass_transmission_color

Deliver transmission color pass

Type:boolean, default False, (readonly)

use_pass_transmission_direct

Deliver transmission direct pass

Type:boolean, default False, (readonly)

use_pass_transmission_indirect

Deliver transmission indirect pass

Type:boolean, default False, (readonly)

use_pass_uv

Deliver texture UV pass

Type:boolean, default False, (readonly)

use_pass_vector

Deliver speed vector pass

Type:boolean, default False, (readonly)

use_pass_z

Deliver Z values pass

Type:boolean, default False, (readonly)

use_sky

Render Sky in this Layer

Type:boolean, default False, (readonly)

use_solid

Render Solid faces in this Layer

Type:boolean, default False, (readonly)

use_strand

Render Strands in this Layer

Type:boolean, default False, (readonly)

use_zmask

Only render what’s in front of the solid z values

Type:boolean, default False, (readonly)

use_ztransp

Render Z-Transparent faces in this Layer (on top of Solid and Halos)

Type:boolean, default False, (readonly)

load_from_file(filename, x=0, y=0)

Copies the pixels of this renderlayer from an image file

Parameters:

• filename (string, (never None)) – Filename, Filename to load into this render tile, must be no smaller than the renderlayer
• x (int in [0, inf], (optional)) – Offset X, Offset the position to copy from if the image is larger than the render layer
• y (int in [0, inf], (optional)) – Offset Y, Offset the position to copy from if the image is larger than the render layer

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_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_unset bpy_struct.type_recast bpy_struct.values

References

RenderResult.layers