LightProbeVolume(LightProbe)#

base classes — bpy_struct, ID, LightProbe

class bpy.types.LightProbeVolume(LightProbe)#

Light probe that captures low frequency lighting inside a volume

bake_samples#

Number of ray directions to evaluate when baking

Type:

int in [1, inf], default 2048

capture_distance#

Distance around the probe volume that will be considered during the bake

Type:

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

capture_emission#

Bake emissive surfaces for more accurate lighting

Type:

boolean, default True

capture_indirect#

Bake light bounces from light sources for more accurate lighting

Type:

boolean, default True

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

clamp_direct#

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

Type:

float in [0, inf], default 0.0

clamp_indirect#

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

Type:

float in [0, inf], default 10.0

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

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

escape_bias#

Distance to search for valid capture positions to prevent lighting artifacts

Type:

float in [0, 1], default 0.1

facing_bias#

Smoother irradiance interpolation but introduce light bleeding

Type:

float in [0, inf], default 0.5

intensity#

Modify the intensity of the lighting captured by this probe

Type:

float in [0, inf], default 1.0

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

resolution_x#

Number of samples along the x axis of the volume

Type:

int in [1, 256], default 4

resolution_y#

Number of samples along the y axis of the volume

Type:

int in [1, 256], default 4

resolution_z#

Number of samples along the z axis of the volume

Type:

int in [1, 256], default 4

surface_bias#

Moves capture points away from surfaces to prevent artifacts

Type:

float in [0, 1], default 0.05

surfel_density#

Number of surfels to spawn in one local unit distance (higher values improve quality)

Type:

int in [1, inf], default 20

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

view_bias#

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

Type:

float in [0, inf], default 0.0

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#

Inherited Functions#