AreaLight(Light)#

base classes — bpy_struct, ID, Light

class bpy.types.AreaLight(Light)#

Directional area Light

contact_shadow_bias#

Bias to avoid self shadowing

Type:

float in [0.001, 9999], default 0.03

contact_shadow_distance#

World space distance in which to search for screen space occluder

Type:

float in [0, 9999], default 0.2

contact_shadow_thickness#

Pixel thickness used to detect occlusion

Type:

float in [0, 9999], default 0.2

energy#

Light energy emitted over the entire area of the light in all directions

Type:

float in [-inf, inf], default 10.0

shadow_buffer_bias#

Bias for reducing self shadowing

Type:

float in [0, inf], default 1.0

shadow_buffer_clip_start#

Shadow map clip start, below which objects will not generate shadows

Type:

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

shadow_color#

Color of shadows cast by the light

Type:

mathutils.Color of 3 items in [0, inf], default (0.0, 0.0, 0.0)

shadow_filter_radius#

Blur shadow aliasing using Percentage Closer Filtering

Type:

float in [0, inf], default 3.0

shadow_resolution_scale#

Scale the Shadow Map target resolution, where 1.0 tries to match shadow map and screen pixel density. (The scale is applied on top of the scene Simplify Shadow Resolution)

Type:

float in [0, 2], default 1.0

shadow_soft_size#

Light size for ray shadow sampling (Raytraced shadows)

Type:

float in [0, inf], default 0.0

shadow_softness_factor#

Scale light shape for smaller penumbra

Type:

float in [0, 1], default 1.0

shape#

Shape of the area Light

Type:

enum in [‘SQUARE’, ‘RECTANGLE’, ‘DISK’, ‘ELLIPSE’], default ‘SQUARE’

size#

Size of the area of the area light, X direction size for rectangle shapes

Type:

float in [0, inf], default 0.25

size_y#

Size of the area of the area light in the Y direction for rectangle shapes

Type:

float in [0, inf], default 0.25

spread#

How widely the emitted light fans out, as in the case of a gridded softbox

Type:

float in [0, 3.14159], default 3.14159

use_contact_shadow#

Use screen space ray-tracing to have correct shadowing near occluder, or for small features that does not appear in shadow maps

Type:

boolean, default False

use_shadow#
Type:

boolean, default True

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#

Inherited Functions#