View3DShading(bpy_struct)

base class — bpy_struct

class bpy.types.View3DShading(bpy_struct)

Settings for shading in the 3D viewport

aov_name

Name of the active Shader AOV (default “”, never None)

Type:

str

background_color

Color for custom background color (array of 3 items, in [0, 1], default (0.05, 0.05, 0.05))

Type:

mathutils.Color

background_type

Way to display the background (default 'THEME')

  • THEME Theme – Use the theme for background color.

  • WORLD World – Use the world for background color.

  • VIEWPORT Custom – Use a custom color limited to this viewport only.

Type:

Literal[‘THEME’, ‘WORLD’, ‘VIEWPORT’]

cavity_ridge_factor

Factor for the cavity ridges (in [0, 250], default 1.0)

Type:

float

cavity_type

Way to display the cavity shading (default 'SCREEN')

  • WORLD World – Cavity shading computed in world space, useful for larger-scale occlusion.

  • SCREEN Screen – Curvature-based shading, useful for making fine details more visible.

  • BOTH Both – Use both effects simultaneously.

Type:

Literal[‘WORLD’, ‘SCREEN’, ‘BOTH’]

cavity_valley_factor

Factor for the cavity valleys (in [0, 250], default 1.0)

Type:

float

color_type

Color Type (default 'MATERIAL')

  • MATERIAL Material – Show material color.

  • OBJECT Object – Show object color.

  • RANDOM Random – Show random object color.

  • VERTEX Attribute – Show active color attribute.

  • TEXTURE Texture – Show the texture from the active image texture node using the active UV map coordinates.

  • SINGLE Custom – Show scene in a single custom color.

Type:

Literal[‘MATERIAL’, ‘OBJECT’, ‘RANDOM’, ‘VERTEX’, ‘TEXTURE’, ‘SINGLE’]

curvature_ridge_factor

Factor for the curvature ridges (in [0, 2], default 1.0)

Type:

float

curvature_valley_factor

Factor for the curvature valleys (in [0, 2], default 1.0)

Type:

float

light

Lighting Method for Solid/Texture Viewport Shading (default 'STUDIO')

  • STUDIO Studio – Display using studio lighting.

  • MATCAP MatCap – Display using matcap material and lighting.

  • FLAT Flat – Display using flat lighting.

Type:

Literal[‘STUDIO’, ‘MATCAP’, ‘FLAT’]

object_outline_color

Color for object outline (array of 3 items, in [0, 1], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

render_pass

Render Pass to show in the viewport (default 'COMBINED')

Type:

Literal[‘COMBINED’, ‘EMISSION’, ‘ENVIRONMENT’, ‘AO’, ‘SHADOW’, ‘TRANSPARENT’, ‘DIFFUSE_LIGHT’, ‘DIFFUSE_COLOR’, ‘SPECULAR_LIGHT’, ‘SPECULAR_COLOR’, ‘VOLUME_LIGHT’, ‘POSITION’, ‘NORMAL’, ‘MIST’, ‘CryptoObject’, ‘CryptoAsset’, ‘CryptoMaterial’, ‘AOV’]

selected_studio_light

Selected StudioLight (readonly)

Type:

StudioLight

shadow_intensity

Darkness of shadows (in [0, 1], default 0.5)

Type:

float

show_backface_culling

Use back face culling to hide the back side of faces (default False)

Type:

bool

show_cavity

Show Cavity (default False)

Type:

bool

show_object_outline

Show Object Outline (default False)

Type:

bool

show_shadows

Show Shadow (default False)

Type:

bool

show_specular_highlight

Render specular highlights (default True)

Type:

bool

show_xray

Show whole scene transparent (default False)

Type:

bool

show_xray_wireframe

Show whole scene transparent (default True)

Type:

bool

single_color

Color for single color mode (array of 3 items, in [0, 1], default (0.8, 0.8, 0.8))

Type:

mathutils.Color

studio_light

Studio lighting setup (default 'DEFAULT')

Type:

Literal[‘DEFAULT’]

studiolight_background_alpha

Show the studiolight in the background (in [0, 1], default 0.0)

Type:

float

studiolight_background_blur

Blur the studiolight in the background (in [0, 1], default 0.5)

Type:

float

studiolight_intensity

Strength of the studiolight (in [0, inf], default 1.0)

Type:

float

studiolight_rotate_z

Rotation of the studiolight around the Z-Axis (in [-3.14159, 3.14159], default 0.0)

Type:

float

type

Method to display/shade objects in the 3D View (default 'SOLID')

Type:

Literal[Shading Type Items]

use_compositor

When to preview the compositor output inside the viewport (default 'DISABLED')

  • DISABLED Disabled – The compositor is disabled.

  • CAMERA Camera – The compositor is enabled only in camera view.

  • ALWAYS Always – The compositor is always enabled regardless of the view.

Type:

Literal[‘DISABLED’, ‘CAMERA’, ‘ALWAYS’]

use_dof

Use depth of field on viewport using the values from the active camera (default False)

Type:

bool

use_scene_lights

Render lights and light probes of the scene (default False)

Type:

bool

use_scene_lights_render

Render lights and light probes of the scene (default True)

Type:

bool

use_scene_world

Use scene world for lighting (default False)

Type:

bool

use_scene_world_render

Use scene world for lighting (default True)

Type:

bool

use_studiolight_view_rotation

Make the HDR rotation fixed and not follow the camera (default True)

Type:

bool

use_world_space_lighting

Make the lighting fixed and not follow the camera (default False)

Type:

bool

wireframe_color_type

Wire Color Type (default 'THEME')

  • THEME Theme – Show scene wireframes with the theme’s wire color.

  • OBJECT Object – Show object color on wireframe.

  • RANDOM Random – Show random object color on wireframe.

Type:

Literal[‘THEME’, ‘OBJECT’, ‘RANDOM’]

xray_alpha

Amount of opacity to use (in [0, 1], default 0.5)

Type:

float

xray_alpha_wireframe

Amount of opacity to use (in [0, 1], default 0.5)

Type:

float

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 (bool) – Ensure that system properties are created if they do not exist yet (optional)

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 bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References