Light2D

继承

Node2D

简要描述

在2D环境中投射光线。

描述

在2D环境中投射光线。光源有纹理，颜色，能量,模式等其他参数决定。

注意： Light2D也可以用作遮罩。

成员

类型	属性名	默认值
Color	color	Color( 1, 1, 1, 1 )
bool	editor_only	false
bool	enabled	true
float	energy	1.0
int	mode	0
Vector2	offset	Vector2( 0, 0 )
float	range_height	0.0
int	range_item_cull_mask	1
int	range_layer_max	0
int	range_layer_min	0
int	range_z_max	1024
int	range_z_min	-1024
int	shadow_buffer_size	2048
Color	shadow_color	Color( 0, 0, 0, 0 )
bool	shadow_enabled	false
int	shadow_filter	0
float	shadow_filter_smooth	0.0
float	shadow_gradient_length	0.0
int	shadow_item_cull_mask	1
Texture	texture
float	texture_scale	1.0

枚举

enum Mode:

• **MODE_ADD = 0**

将与Light2D对应的像素值添加到其下方的像素值。

• **MODE_SUB = 1**

将与Light2D对应的像素值减为其下的像素值，从而产生反光效果。

• **MODE_MIX = 2**

通过线性插值将与Light2D对应的像素值与其下的像素值混合。

• **MODE_MASK = 3**

根据光照（蒙版）纹理的每个像素的值，Light2D的光照纹理用作蒙版，隐藏或显示屏幕下方的部分。

---

enum ShadowFilter:

• **SHADOW_FILTER_NONE = 0**

没有过滤器适用于阴影贴图。

• **SHADOW_FILTER_PCF3 = 1**

百分比更近过滤（3个样本）适用于阴影贴图。

• **SHADOW_FILTER_PCF5 = 2**

百分比更近过滤（5个样本）适用于阴影贴图。

• **SHADOW_FILTER_PCF7 = 3**

百分比更近过滤（7个样本）适用于阴影贴图。

• **SHADOW_FILTER_PCF9 = 4**

百分比更近过滤（9个样本）适用于阴影贴图。

• **SHADOW_FILTER_PCF13 = 5**

百分比更近过滤（13个样本）适用于阴影贴图。

---

成员说明

• Color color

Default	Color( 1, 1, 1, 1 )
setter	set_color(value)
getter	get_color

• bool editor_only

Default	false
setter	set_editor_only(value)
getter	is_editor_only

• bool enabled

Default	true
setter	set_enabled(value)
getter	is_enabled

• float energy

Default	1.0
setter	set_energy(value)
getter	get_energy

• int mode

Default	0
setter	set_mode(value)
getter	get_mode

• Vector2 offset

Default	Vector2( 0, 0 )
setter	set_texture_offset(value)
getter	get_texture_offset

• float range_height

Default	0.0
setter	set_height(value)
getter	get_height

• int range_item_cull_mask

Default	1
setter	set_item_cull_mask(value)
getter	get_item_cull_mask

• int range_layer_max

Default	0
setter	set_layer_range_max(value)
getter	get_layer_range_max

• int range_layer_min

Default	0
setter	set_layer_range_min(value)
getter	get_layer_range_min

• int range_z_max

Default	1024
setter	set_z_range_max(value)
getter	get_z_range_max

• int range_z_min

Default	-1024
setter	set_z_range_min(value)
getter	get_z_range_min

• int shadow_buffer_size

Default	2048
setter	set_shadow_buffer_size(value)
getter	get_shadow_buffer_size

• Color shadow_color

Default	Color( 0, 0, 0, 0 )
setter	set_shadow_color(value)
getter	get_shadow_color

• bool shadow_enabled

Default	false
setter	set_shadow_enabled(value)
getter	is_shadow_enabled

• int shadow_filter

Default	0
setter	set_shadow_filter(value)
getter	get_shadow_filter

• float shadow_filter_smooth

Default	0.0
setter	set_shadow_smooth(value)
getter	get_shadow_smooth

• float shadow_gradient_length

Default	0.0
setter	set_shadow_gradient_length(value)
getter	get_shadow_gradient_length

• int shadow_item_cull_mask

Default	1
setter	set_item_shadow_cull_mask(value)
getter	get_item_shadow_cull_mask

• Texture texture

setter	set_texture(value)
getter	get_texture

• float texture_scale

Default	1.0
setter	set_texture_scale(value)
getter	get_texture_scale