ViewLayer(bpy_struct)

base class — bpy_struct

class bpy.types.ViewLayer(bpy_struct)

View layer

active_aov

Active AOV

Type

AOV, (readonly)

active_aov_index

Index of active AOV

Type

int in [0, inf], default 0

active_layer_collection

Active layer collection in this view layer’s hierarchy

Type

LayerCollection, (never None)

active_lightgroup

Active Lightgroup

Type

Lightgroup, (readonly)

active_lightgroup_index

Index of active lightgroup

Type

int in [0, inf], default 0

aovs

Type

AOVs bpy_prop_collection of AOV, (readonly)

cycles

Cycles ViewLayer Settings

Type

CyclesRenderLayerSettings, (readonly)

depsgraph

Dependencies in the scene data

Type

Depsgraph, (readonly)

eevee

View layer settings for EEVEE

Type

ViewLayerEEVEE, (readonly, never None)

freestyle_settings

Type

FreestyleSettings, (readonly, never None)

has_export_collections

At least one Collection in this View Layer has an exporter

Type

boolean, default False, (readonly)

layer_collection

Root of collections hierarchy of this view layer, its ‘collection’ pointer property is the same as the scene’s master collection

Type

LayerCollection, (readonly, never None)

lightgroups

Type

Lightgroups bpy_prop_collection of Lightgroup, (readonly)

material_override

Material to override all other materials in this view layer

Type

Material

name

View layer name

Type

string, default “”, (never None)

objects

All the objects in this layer

Type

LayerObjects bpy_prop_collection of Object, (readonly)

pass_alpha_threshold

Z, Index, normal, UV and vector passes are only affected by surfaces with alpha transparency equal to or higher than this threshold

Type

float in [0, 1], default 0.5

pass_cryptomatte_depth

Sets how many unique objects can be distinguished per pixel

Type

int in [2, 16], default 6

samples

Override number of render samples for this view layer, 0 will use the scene setting

Type

int in [0, inf], default 0

use

Enable or disable rendering of this View Layer

Type

boolean, default True

use_ao

Render Ambient Occlusion in this Layer

Type

boolean, default True

use_freestyle

Render stylized strokes in this Layer

Type

boolean, default True

use_grease_pencil

Render Grease Pencil on this layer

Type

boolean, default True

use_motion_blur

Render motion blur in this Layer, if enabled in the scene

Type

boolean, default True

use_pass_ambient_occlusion

Deliver Ambient Occlusion pass

Type

boolean, default False

use_pass_combined

Deliver full combined RGBA buffer

Type

boolean, default True

use_pass_cryptomatte_accurate

Generate a more accurate cryptomatte pass

Type

boolean, default True

use_pass_cryptomatte_asset

Render cryptomatte asset pass, for isolating groups of objects with the same parent

Type

boolean, default False

use_pass_cryptomatte_material

Render cryptomatte material pass, for isolating materials in compositing

Type

boolean, default False

use_pass_cryptomatte_object

Render cryptomatte object pass, for isolating objects in compositing

Type

boolean, default False

use_pass_diffuse_color

Deliver diffuse color pass

Type

boolean, default False

use_pass_diffuse_direct

Deliver diffuse direct pass

Type

boolean, default False

use_pass_diffuse_indirect

Deliver diffuse indirect pass

Type

boolean, default False

use_pass_emit

Deliver emission pass

Type

boolean, default False

use_pass_environment

Deliver environment lighting pass

Type

boolean, default False

use_pass_glossy_color

Deliver glossy color pass

Type

boolean, default False

use_pass_glossy_direct

Deliver glossy direct pass

Type

boolean, default False

use_pass_glossy_indirect

Deliver glossy indirect pass

Type

boolean, default False

use_pass_grease_pencil

Deliver Grease Pencil render result in a separate pass

Type

boolean, default False

use_pass_material_index

Deliver material index pass

Type

boolean, default False

use_pass_mist

Deliver mist factor pass (0.0 to 1.0)

Type

boolean, default False

use_pass_normal

Deliver normal pass

Type

boolean, default False

use_pass_object_index

Deliver object index pass

Type

boolean, default False

use_pass_position

Deliver position pass

Type

boolean, default False

use_pass_shadow

Deliver shadow pass

Type

boolean, default False

use_pass_subsurface_color

Deliver subsurface color pass

Type

boolean, default False

use_pass_subsurface_direct

Deliver subsurface direct pass

Type

boolean, default False

use_pass_subsurface_indirect

Deliver subsurface indirect pass

Type

boolean, default False

use_pass_transmission_color

Deliver transmission color pass

Type

boolean, default False

use_pass_transmission_direct

Deliver transmission direct pass

Type

boolean, default False

use_pass_transmission_indirect

Deliver transmission indirect pass

Type

boolean, default False

use_pass_uv

Deliver texture UV pass

Type

boolean, default False

use_pass_vector

Deliver speed vector pass

Type

boolean, default False

use_pass_z

Deliver depth values pass

Type

boolean, default False

use_sky

Render Sky in this Layer

Type

boolean, default True

use_solid

Render Solid faces in this Layer

Type

boolean, default True

use_strand

Render Strands in this Layer

Type

boolean, default True

use_volumes

Render volumes in this Layer

Type

boolean, default True

world_override

Override world in this view layer

Type

World

bl_system_properties_get(*, do_create=False)

DEBUG ONLY. Internal access to runtime-defined RNA data storage, intended solely for testing and debugging purposes. Do not access it in regular scripting work, and in particular, do not assume that it contains writable data

Parameters

do_create (boolean, (optional)) – Ensure that system properties are created if they do not exist yet

Returns

The system properties root container, or None if there are no system properties stored in this data yet, and its creation was not requested

Return type

PropertyGroup

classmethod update_render_passes()

Requery the enabled render passes from the render engine

update()

Update data tagged to be updated from previous access to data or operators

classmethod bl_rna_get_subclass(id, default=None, /)

Parameters

id (str) – 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 (str) – 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.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui 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.rna_ancestors bpy_struct.type_recast bpy_struct.values

References

bpy.context.view_layer Context.view_layer Depsgraph.view_layer Depsgraph.view_layer_eval ID.override_hierarchy_create IDOverrideLibrary.resync LayerCollection.has_selected_objects Object.hide_get Object.hide_set Object.holdout_get Object.indirect_only_get

Object.select_get Object.select_set Object.visible_get RenderEngine.register_pass RenderEngine.update_render_passes Scene.statistics Scene.view_layers ViewLayers.new ViewLayers.remove Window.view_layer