# 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

  `falloff`

    Control how fast the probe influence decreases

    Type: | float in [0, 1], default 0.2

  `grid_resolution_x`

    Number of sample along the x axis of the volume

    Type: | int in [1, 256], default 4

  `grid_resolution_y`

    Number of sample along the y axis of the volume

    Type: | int in [1, 256], default 4

  `grid_resolution_z`

    Number of sample along the z axis of the volume

    Type: | int in [1, 256], default 4

  `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`

    Show captured lighting data into the 3D view for debugging purpose

    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

  `type`

    Type of light probe

    - `CUBEMAP` Reflection Cubemap, Capture reflections.
    - `PLANAR` Reflection Plane.
    - `GRID` Irradiance Volume, Volume used for precomputing indirect lighting.

    Type: | enum in [‘CUBEMAP’, ‘PLANAR’, ‘GRID’], default ‘CUBEMAP’, (readonly)

  `use_custom_parallax`

    Enable custom settings for the parallax correction volume

    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.is_evaluated` `ID.original` `ID.users` | `ID.use_fake_user` `ID.tag` `ID.is_library_indirect` `ID.library` `ID.override_library` `ID.preview`

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `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.override_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`

References

`bpy.context.lightprobe` `BlendData.lightprobes` | `BlendDataProbes.new` `BlendDataProbes.remove`