LightProbe(ID)

base classes — bpy_struct, ID

class bpy.types.LightProbe(ID)

Light Probe data-block for lighting capture objects

animation_data

Animation data for this data-block

Type:

AnimData, (readonly)

clip_end

Probe clip end, beyond which objects will not appear in reflections

Type:

float in [1e-06, inf], default 40.0

clip_start

Probe clip start, below which objects will not appear in reflections

Type:

float in [1e-06, inf], default 0.8

data_display_size

Viewport display size of the sampled data

Type:

float in [0, inf], default 0.1

falloff

Control how fast the probe influence decreases

Type:

float in [0, 1], default 0.2

grid_bake_samples

Number of ray directions to evaluate when baking

Type:

int in [1, inf], default 2048

grid_capture_emission

Bake emissive surfaces for more accurate lighting

Type:

boolean, default True

grid_capture_indirect

Bake light bounces from light sources for more accurate lighting

Type:

boolean, default True

grid_capture_world

Bake incoming light from the world, instead of just the visibility, for more accurate lighting, but lose correct blending to surrounding irradiance volumes

Type:

boolean, default False

grid_clamp_direct

Clamp the direct lighting intensity to reduce noise (0 to disable)

Type:

float in [0, inf], default 0.0

grid_clamp_indirect

Clamp the indirect lighting intensity to reduce noise (0 to disable)

Type:

float in [0, inf], default 10.0

grid_dilation_radius

Radius in grid sample to search valid grid samples to copy into invalid grid samples

Type:

float in [1, 5], default 1.0

grid_dilation_threshold

Ratio of front-facing surface hits under which a grid sample will reuse neighbors grid sample lighting

Type:

float in [0, 1], default 0.5

grid_escape_bias

Moves capture points outside objects

Type:

float in [0, 1], default 0.1

grid_irradiance_smoothing

Smoother irradiance interpolation but introduce light bleeding

Type:

float in [0, inf], default 0.5

grid_normal_bias

Offset sampling of the irradiance grid in the surface normal direction to reduce light bleeding

Type:

float in [0, inf], default 0.3

grid_resolution_x

Number of samples along the x axis of the volume

Type:

int in [1, 256], default 4

grid_resolution_y

Number of samples along the y axis of the volume

Type:

int in [1, 256], default 4

grid_resolution_z

Number of samples along the z axis of the volume

Type:

int in [1, 256], default 4

grid_surface_bias

Moves capture points position away from surfaces to avoid artifacts

Type:

float in [0, 1], default 0.05

grid_validity_threshold

Ratio of front-facing surface hits under which a grid sample will not be considered for lighting

Type:

float in [0, 1], default 0.4

grid_view_bias

Offset sampling of the irradiance grid in the viewing direction to reduce light bleeding

Type:

float in [0, inf], default 0.0

influence_distance

Influence distance of the probe

Type:

float in [0, inf], default 2.5

influence_type

Type of influence volume

Type:

enum in [‘ELIPSOID’, ‘BOX’], default ‘ELIPSOID’

intensity

Modify the intensity of the lighting captured by this probe

Type:

float in [0, inf], default 1.0

invert_visibility_collection

Invert visibility collection

Type:

boolean, default False

parallax_distance

Lowest corner of the parallax bounding box

Type:

float in [0, inf], default 2.5

parallax_type

Type of parallax volume

Type:

enum in [‘ELIPSOID’, ‘BOX’], default ‘ELIPSOID’

show_clip

Show the clipping distances in the 3D view

Type:

boolean, default False

show_data

Deprecated, use use_data_display instead

Type:

boolean, default False

show_influence

Show the influence volume in the 3D view

Type:

boolean, default True

show_parallax

Show the parallax correction volume in the 3D view

Type:

boolean, default False

surfel_density

Number of surfels per unit distance (higher values improve quality)

Type:

float in [0, inf], default 1.0

type

Type of light probe

• 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:

enum in [‘SPHERE’, ‘PLANE’, ‘VOLUME’], default ‘SPHERE’, (readonly)

use_custom_parallax

Enable custom settings for the parallax correction volume

Type:

boolean, default False

use_data_display

Display sampled data in the viewport to debug captured light

Type:

boolean, default False

visibility_bleed_bias

Bias for reducing light-bleed on variance shadow maps

Type:

float in [0, 1], default 0.0

visibility_blur

Filter size of the visibility blur

Type:

float in [0, 1], default 0.2

visibility_buffer_bias

Bias for reducing self shadowing

Type:

float in [0.001, 9999], default 1.0

visibility_collection

Restrict objects visible for this probe

Type:

Collection

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 ID.name ID.name_full ID.id_type ID.session_uid ID.is_evaluated ID.original ID.users ID.use_fake_user ID.use_extra_user

ID.is_embedded_data ID.is_missing ID.is_runtime_data ID.tag ID.is_library_indirect ID.library ID.library_weak_reference ID.asset_data ID.override_library ID.preview

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.type_recast bpy_struct.values ID.evaluated_get ID.copy ID.asset_mark ID.asset_clear ID.asset_generate_preview ID.override_create ID.override_hierarchy_create ID.user_clear ID.user_remap ID.make_local ID.user_of_id ID.animation_data_create ID.animation_data_clear ID.update_tag ID.preview_ensure ID.bl_rna_get_subclass ID.bl_rna_get_subclass_py

References

bpy.context.lightprobe BlendData.lightprobes

BlendDataProbes.new BlendDataProbes.remove