SpotLamp(Lamp)

base classes — bpy_struct, ID, Lamp

class bpy.types.SpotLamp(Lamp)

Directional cone lamp

compression_threshold

Deep shadow map compression threshold

Type:float in [0, 1], default 0.0
constant_coefficient

Constant distance attenuation coefficient

Type:float in [0, inf], default 0.0
cutoff_threshold

Cutoff Threshold

Type:float in [0, 0.999], default 0.0
falloff_curve

Custom Lamp Falloff Curve

Type:CurveMapping, (readonly)
falloff_type

Intensity Decay with distance

Type:enum in [‘CONSTANT’, ‘INVERSE_LINEAR’, ‘INVERSE_SQUARE’, ‘INVSQUARE_CUTOFF’, ‘INVERSE_COEFFICIENTS’, ‘CUSTOM_CURVE’, ‘LINEAR_QUADRATIC_WEIGHTED’], default ‘CONSTANT’
ge_shadow_buffer_type

The shadow mapping algorithm used

  • SIMPLE Simple, Simple shadow maps.
  • VARIANCE Variance, Variance shadow maps.
Type:enum in [‘SIMPLE’, ‘VARIANCE’], default ‘SIMPLE’
halo_intensity

Brightness of the spotlight’s halo cone

Type:float in [-inf, inf], default 0.0
halo_step

Volumetric halo sampling frequency

Type:int in [0, 12], default 0
linear_attenuation

Linear distance attenuation

Type:float in [0, 1], default 0.0
linear_coefficient

Linear distance attenuation coefficient

Type:float in [0, inf], default 0.0
quadratic_attenuation

Quadratic distance attenuation

Type:float in [0, 1], default 0.0
quadratic_coefficient

Quadratic distance attenuation coefficient

Type:float in [0, inf], default 0.0
radius

The ligth’s radius

Type:float in [0.001, inf], default 0.0
shadow_adaptive_threshold

Threshold for Adaptive Sampling (Raytraced shadows)

Type:float in [0, 1], default 0.0
shadow_buffer_bias

Shadow buffer sampling bias

Type:float in [0.001, 5], default 0.0
shadow_buffer_bleed_bias

Bias for reducing light-bleed on variance shadow maps

Type:float in [0, 1], default 0.0
shadow_buffer_clip_end

Shadow map clip end, beyond which objects will not generate shadows

Type:float in [0, 9999], default 0.0
shadow_buffer_clip_start

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

Type:float in [0, 9999], default 0.0
shadow_buffer_samples

Number of shadow buffer samples

Type:int in [1, 16], default 0
shadow_buffer_sharp

Sharpness of buffer sampling

Type:float in [-1, 1], default 0.0
shadow_buffer_size

Resolution of the shadow buffer, higher values give crisper shadows but use more memory

Type:int in [128, 10240], default 0
shadow_buffer_slope_bias

Shadow buffer sampling slope bias

Type:float in [0, 5], default 0.0
shadow_buffer_soft

Size of shadow buffer sampling area

Type:float in [0, 100], default 0.0
shadow_buffer_type

Type of shadow buffer

  • REGULAR Classical, Classic shadow buffer.
  • HALFWAY Classic-Halfway, Regular buffer, averaging the closest and 2nd closest Z value to reducing bias artifacts.
  • IRREGULAR Irregular, Irregular buffer produces sharp shadow always, but it doesn’t show up for raytracing.
  • DEEP Deep, Deep shadow buffer supports transparency and better filtering, at the cost of more memory usage and processing time.
Type:enum in [‘REGULAR’, ‘HALFWAY’, ‘IRREGULAR’, ‘DEEP’], default ‘REGULAR’
shadow_color

Color of shadows cast by the lamp

Type:float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
shadow_filter

The shadow mapping filtering algorithm used

  • NONE None, None filtering.
  • PCF PCF, Percentage Closer Filtering.
  • PCF_BAIL PCF Early Bail, Percentage Closer Filtering Early Bail.
  • PCF_JITTER PCF Jitter, Percentage Closer Filtering Jitter.
Type:enum in [‘NONE’, ‘PCF’, ‘PCF_BAIL’, ‘PCF_JITTER’], default ‘NONE’
shadow_filter_type

Type of shadow filter (Buffer Shadows)

  • BOX Box, Apply the Box filter to shadow buffer samples.
  • TENT Tent, Apply the Tent Filter to shadow buffer samples.
  • GAUSS Gauss, Apply the Gauss filter to shadow buffer samples.
Type:enum in [‘BOX’, ‘TENT’, ‘GAUSS’], default ‘BOX’
shadow_method
  • NOSHADOW No Shadow.
  • BUFFER_SHADOW Buffer Shadow, Let spotlight produce shadows using shadow buffer.
  • RAY_SHADOW Ray Shadow, Use ray tracing for shadow.
Type:enum in [‘NOSHADOW’, ‘BUFFER_SHADOW’, ‘RAY_SHADOW’], default ‘NOSHADOW’
shadow_ray_sample_method

Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower

Type:enum in [‘ADAPTIVE_QMC’, ‘CONSTANT_QMC’], default ‘ADAPTIVE_QMC’
shadow_ray_samples

Number of samples taken extra (samples x samples)

Type:int in [1, 64], default 0
shadow_sample_buffers

Number of shadow buffers to render for better AA, this increases memory usage

  • BUFFERS_1 1, Only one buffer rendered.
  • BUFFERS_4 4, Render 4 buffers for better AA, this quadruples memory usage.
  • BUFFERS_9 9, Render 9 buffers for better AA, this uses nine times more memory.
Type:enum in [‘BUFFERS_1’, ‘BUFFERS_4’, ‘BUFFERS_9’], default ‘BUFFERS_1’
shadow_soft_size

Light size for ray shadow sampling (Raytraced shadows)

Type:float in [0, inf], default 0.0
show_cone

Draw transparent cone in 3D view to visualize which objects are contained in it

Type:boolean, default False
show_shadow_box

Draw a box in 3D view to visualize which objects are contained in it

Type:boolean, default False
spot_blend

The softness of the spotlight edge

Type:float in [0, 1], default 0.0
spot_size

Angle of the spotlight beam

Type:float in [0.0174533, 3.14159], default 0.0
static_shadow

Enable static shadows

Type:boolean, default False
use_auto_clip_end

Automatic calculation of clipping-end, based on visible vertices

Type:boolean, default False
use_auto_clip_start

Automatic calculation of clipping-start, based on visible vertices

Type:boolean, default False
use_halo

Render spotlight with a volumetric halo

Type:boolean, default False
use_only_shadow

Cast shadows only, without illuminating objects

Type:boolean, default False
use_shadow
Type:boolean, default False
use_shadow_layer

Objects on the same layers only cast shadows

Type:boolean, default False
use_sphere

Set light intensity to zero beyond lamp distance

Type:boolean, default False
use_square

Cast a square spot light shape

Type:boolean, default False
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