LightProbe(ID)

base classes — bpy_struct, ID

subclasses — LightProbePlane, LightProbeSphere, LightProbeVolume

class bpy.types.LightProbe(ID)

Light Probe data-block for lighting capture objects

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

clip_start

Probe clip start, below which objects will not appear in reflections (in [1e-06, inf], default 0.8)

Type:

float

data_display_size

Viewport display size of the sampled data (in [0, inf], default 0.1)

Type:

float

influence_distance

Influence distance of the probe (in [0, inf], default 2.5)

Type:

float

invert_visibility_collection

Invert visibility collection (Deprecated) (default False)

Type:

bool

show_clip

Show the clipping distances in the 3D view (default False)

Type:

bool

show_data

Deprecated, use use_data_display instead (default False)

Type:

bool

show_influence

Show the influence volume in the 3D view (default True)

Type:

bool

type

Type of light probe (default 'SPHERE', readonly)

  • SPHERE Sphere – Light probe that captures precise lighting from all directions at a single point in space.

  • PLANE Plane – Light probe that captures incoming light from a single direction on a plane.

  • VOLUME Volume – Light probe that captures low frequency lighting inside a volume.

Type:

Literal[‘SPHERE’, ‘PLANE’, ‘VOLUME’]

use_data_display

Display sampled data in the viewport to debug captured light (default False)

Type:

bool

visibility_bleed_bias

Bias for reducing light-bleed on variance shadow maps (Deprecated) (in [0, 1], default 0.0)

Type:

float

visibility_blur

Filter size of the visibility blur (Deprecated) (in [0, 1], default 0.2)

Type:

float

visibility_buffer_bias

Bias for reducing self shadowing (Deprecated) (in [0.001, 9999], default 1.0)

Type:

float

visibility_collection

Restrict objects visible for this probe (Deprecated)

Type:

Collection

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

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

Inherited Functions

References