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 (in [1, inf], default 2048)

Type:

int

capture_distance

Distance around the probe volume that will be considered during the bake (in [1e-06, inf], default 20.0)

Type:

float

capture_emission

Bake emissive surfaces for more accurate lighting (default True)

Type:

bool

capture_indirect

Bake light bounces from light sources for more accurate lighting (default True)

Type:

bool

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 (default False)

Type:

bool

clamp_direct

Clamp the direct lighting intensity to reduce noise (0 to disable) (in [0, inf], default 0.0)

Type:

float

clamp_indirect

Clamp the indirect lighting intensity to reduce noise (0 to disable) (in [0, inf], default 10.0)

Type:

float

dilation_radius

Radius in grid sample to search valid grid samples to copy into invalid grid samples (in [1, 5], default 1.0)

Type:

float

dilation_threshold

Ratio of front-facing surface hits under which a grid sample will reuse neighbors grid sample lighting (in [0, 1], default 0.5)

Type:

float

escape_bias

Distance to search for valid capture positions to prevent lighting artifacts (in [0, 1], default 0.1)

Type:

float

facing_bias

Smoother irradiance interpolation but introduce light bleeding (in [0, inf], default 0.5)

Type:

float

intensity

Modify the intensity of the lighting captured by this probe (in [0, inf], default 1.0)

Type:

float

normal_bias

Offset sampling of the irradiance grid in the surface normal direction to reduce light bleeding (in [0, inf], default 0.3)

Type:

float

resolution_x

Number of samples along the x axis of the volume (in [1, 256], default 4)

Type:

int

resolution_y

Number of samples along the y axis of the volume (in [1, 256], default 4)

Type:

int

resolution_z

Number of samples along the z axis of the volume (in [1, 256], default 4)

Type:

int

surface_bias

Moves capture points away from surfaces to prevent artifacts (in [0, 1], default 0.05)

Type:

float

surfel_density

Number of surfels to spawn in one local unit distance (higher values improve quality) (in [1, inf], default 20)

Type:

int

validity_threshold

Ratio of front-facing surface hits under which a grid sample will not be considered for lighting (in [0, 1], default 0.4)

Type:

float

view_bias

Offset sampling of the irradiance grid in the viewing direction to reduce light bleeding (in [0, inf], default 0.0)

Type:

float

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