Environment

继承

Resource

简要描述

定义多个渲染选项的环境节点（例如WorldEnvironment）的资源。

描述

用于定义多个环境操作（例如背景Sky或Color，环境光，雾，景深...）的环境节点（例如WorldEnvironment）的资源。这些参数影响场景的最终渲染。这些操作的顺序为：

• 景深模糊

• 发光

• 色调图（自动曝光）

• 调整

成员

类型	属性名	默认值
float	adjustment_brightness	1.0
Texture	adjustment_color_correction
float	adjustment_contrast	1.0
bool	adjustment_enabled	false
float	adjustment_saturation	1.0
Color	ambient_light_color	Color( 0, 0, 0, 1 )
float	ambient_light_energy	1.0
float	ambient_light_sky_contribution	1.0
bool	auto_exposure_enabled	false
float	auto_exposure_max_luma	8.0
float	auto_exposure_min_luma	0.05
float	auto_exposure_scale	0.4
float	auto_exposure_speed	0.5
int	background_camera_feed_id	1
int	background_canvas_max_layer	0
Color	background_color	Color( 0, 0, 0, 1 )
float	background_energy	1.0
int	background_mode	0
Sky	background_sky
float	background_sky_custom_fov	0.0
Basis	background_sky_orientation	Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )
Vector3	background_sky_rotation	Vector3( 0, 0, 0 )
Vector3	background_sky_rotation_degrees	Vector3( 0, 0, 0 )
float	dof_blur_far_amount	0.1
float	dof_blur_far_distance	10.0
bool	dof_blur_far_enabled	false
int	dof_blur_far_quality	1
float	dof_blur_far_transition	5.0
float	dof_blur_near_amount	0.1
float	dof_blur_near_distance	2.0
bool	dof_blur_near_enabled	false
int	dof_blur_near_quality	1
float	dof_blur_near_transition	1.0
Color	fog_color	Color( 0.5, 0.6, 0.7, 1 )
float	fog_depth_begin	10.0
float	fog_depth_curve	1.0
bool	fog_depth_enabled	true
float	fog_depth_end	100.0
bool	fog_enabled	false
float	fog_height_curve	1.0
bool	fog_height_enabled	false
float	fog_height_max	0.0
float	fog_height_min	10.0
float	fog_sun_amount	0.0
Color	fog_sun_color	Color( 1, 0.9, 0.7, 1 )
float	fog_transmit_curve	1.0
bool	fog_transmit_enabled	false
bool	glow_bicubic_upscale	false
int	glow_blend_mode	2
float	glow_bloom	0.0
bool	glow_enabled	false
float	glow_hdr_luminance_cap	12.0
float	glow_hdr_scale	2.0
float	glow_hdr_threshold	1.0
float	glow_intensity	0.8
bool	glow_levels/1	false
bool	glow_levels/2	false
bool	glow_levels/3	true
bool	glow_levels/4	false
bool	glow_levels/5	true
bool	glow_levels/6	false
bool	glow_levels/7	false
float	glow_strength	1.0
float	ss_reflections_depth_tolerance	0.2
bool	ss_reflections_enabled	false
float	ss_reflections_fade_in	0.15
float	ss_reflections_fade_out	2.0
int	ss_reflections_max_steps	64
bool	ss_reflections_roughness	true
float	ssao_ao_channel_affect	0.0
float	ssao_bias	0.01
int	ssao_blur	3
Color	ssao_color	Color( 0, 0, 0, 1 )
float	ssao_edge_sharpness	4.0
bool	ssao_enabled	false
float	ssao_intensity	1.0
float	ssao_intensity2	1.0
float	ssao_light_affect	0.0
int	ssao_quality	1
float	ssao_radius	1.0
float	ssao_radius2	0.0
float	tonemap_exposure	1.0
int	tonemap_mode	0
float	tonemap_white	1.0

方法

返回值类型	方法名称
bool	is_glow_level_enabled(idx: int) const
void	set_glow_level(idx: int, enabled: bool)

枚举

enum BGMode:

• **BG_KEEP = 5**

在屏幕上保持背景绘制的每个像素。这是最快的背景模式，但只能安全地用于全室内场景（无可见的天空或天空反射）。如果在可见背景的场景中启用，则在移动相机时将看到“鬼影痕迹”伪影。

• **BG_CLEAR_COLOR = 0**

使用[ProjectSettings.rendering](/docs/api/object/Singleton/ProjectSettings#method-rendering /environment /default_clear_color)中定义的透明颜色清除背景。

• **BG_COLOR = 1**

使用自定义的清除颜色清除背景。

• **BG_SKY = 2**

在背景中显示用户定义的天空。

• **BG_COLOR_SKY = 3**

使用自定义的透明颜色清除背景，并允许为阴影和反射定义天空。此模式比BG_SKY稍快，在反射可见但天空本身不可见的场景（例如，自上而下的相机）中应优先使用。

• **BG_CANVAS = 4**

在后台显示CanvasLayer。

• **BG_CAMERA_FEED = 6**

在后台显示摄像机源。

• **BG_MAX = 7**

表示BGMode枚举的大小。

---

enum GlowBlendMode:

• **GLOW_BLEND_MODE_ADDITIVE = 0**

附加发光混合模式。主要用于颗粒，发光（光晕），镜头眩光，明亮光源。

• **GLOW_BLEND_MODE_SCREEN = 1**

屏幕发光混合模式。增加亮度，经常与光晕配合使用。

• **GLOW_BLEND_MODE_SOFTLIGHT = 2**

柔光发光混合模式。修改对比度，暴露阴影和高光（鲜艳绽放）。

• **GLOW_BLEND_MODE_REPLACE = 3**

替换发光混合模式。用辉光值替换所有像素的颜色。通过调整发光参数以匹配原始图像的亮度，可以将其用于模拟全屏模糊效果。

---

enum ToneMapper:

• **TONE_MAPPER_LINEAR = 0**

线性色调映射器运算符。读取线性数据并将其传递给未修改的对象。

• **TONE_MAPPER_REINHARDT = 1**

Reinhardt色调映射器运算符。通过以下公式对渲染像素的颜色进行变化：color = color /(1 + color)。

• **TONE_MAPPER_FILMIC = 2**

电影色调映射器运算符。

• **TONE_MAPPER_ACES = 3**

Academy Color编码系统tonemapper运算符。

---

enum DOFBlurQuality:

• **DOF_BLUR_QUALITY_LOW = 0**

低景深模糊质量（最快）。

• **DOF_BLUR_QUALITY_MEDIUM = 1**

中等景深模糊质量。

• **DOF_BLUR_QUALITY_HIGH = 2**

高景深模糊质量（最慢）。

---

enum SSAOBlur:

• **SSAO_BLUR_DISABLED = 0**

屏幕空间环境光遮挡效果不模糊（最快）。

• **SSAO_BLUR_1x1 = 1**

屏幕空间环境光遮蔽效果为1×1模糊。

• **SSAO_BLUR_2x2 = 2**

屏幕空间环境光遮蔽效果2×2模糊。

• **SSAO_BLUR_3x3 = 3**

屏幕空间环境光遮挡效果的3×3模糊（最慢）。

---

enum SSAOQuality:

• **SSAO_QUALITY_LOW = 0**

低质量的屏幕空间环境光遮挡效果（最快）。

• **SSAO_QUALITY_MEDIUM = 1**

中等质量的屏幕空间环境光遮蔽效果。

• **SSAO_QUALITY_HIGH = 2**

高质量的屏幕空间环境光遮挡效果（最慢）。

---

常量

成员说明

• float adjustment_brightness

Default	1.0
setter	set_adjustment_brightness(value)
getter	get_adjustment_brightness

• Texture adjustment_color_correction

setter	set_adjustment_color_correction(value)
getter	get_adjustment_color_correction

• float adjustment_contrast

Default	1.0
setter	set_adjustment_contrast(value)
getter	get_adjustment_contrast

• bool adjustment_enabled

Default	false
setter	set_adjustment_enable(value)
getter	is_adjustment_enabled

• float adjustment_saturation

Default	1.0
setter	set_adjustment_saturation(value)
getter	get_adjustment_saturation

• Color ambient_light_color

Default	Color( 0, 0, 0, 1 )
setter	set_ambient_light_color(value)
getter	get_ambient_light_color

• float ambient_light_energy

Default	1.0
setter	set_ambient_light_energy(value)
getter	get_ambient_light_energy

• float ambient_light_sky_contribution

Default	1.0
setter	set_ambient_light_sky_contribution(value)
getter	get_ambient_light_sky_contribution

• bool auto_exposure_enabled

Default	false
setter	set_tonemap_auto_exposure(value)
getter	get_tonemap_auto_exposure

• float auto_exposure_max_luma

Default	8.0
setter	set_tonemap_auto_exposure_max(value)
getter	get_tonemap_auto_exposure_max

• float auto_exposure_min_luma

Default	0.05
setter	set_tonemap_auto_exposure_min(value)
getter	get_tonemap_auto_exposure_min

• float auto_exposure_scale

Default	0.4
setter	set_tonemap_auto_exposure_grey(value)
getter	get_tonemap_auto_exposure_grey

• float auto_exposure_speed

Default	0.5
setter	set_tonemap_auto_exposure_speed(value)
getter	get_tonemap_auto_exposure_speed

• int background_camera_feed_id

Default	1
setter	set_camera_feed_id(value)
getter	get_camera_feed_id

• int background_canvas_max_layer

Default	0
setter	set_canvas_max_layer(value)
getter	get_canvas_max_layer

• Color background_color

Default	Color( 0, 0, 0, 1 )
setter	set_bg_color(value)
getter	get_bg_color

• float background_energy

Default	1.0
setter	set_bg_energy(value)
getter	get_bg_energy

• int background_mode

Default	0
setter	set_background(value)
getter	get_background

• Sky background_sky

setter	set_sky(value)
getter	get_sky

• float background_sky_custom_fov

Default	0.0
setter	set_sky_custom_fov(value)
getter	get_sky_custom_fov

• Basis background_sky_orientation

Default	Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )
setter	set_sky_orientation(value)
getter	get_sky_orientation

• Vector3 background_sky_rotation

Default	Vector3( 0, 0, 0 )
setter	set_sky_rotation(value)
getter	get_sky_rotation

• Vector3 background_sky_rotation_degrees

Default	Vector3( 0, 0, 0 )
setter	set_sky_rotation_degrees(value)
getter	get_sky_rotation_degrees

• float dof_blur_far_amount

Default	0.1
setter	set_dof_blur_far_amount(value)
getter	get_dof_blur_far_amount

• float dof_blur_far_distance

Default	10.0
setter	set_dof_blur_far_distance(value)
getter	get_dof_blur_far_distance

• bool dof_blur_far_enabled

Default	false
setter	set_dof_blur_far_enabled(value)
getter	is_dof_blur_far_enabled

• int dof_blur_far_quality

Default	1
setter	set_dof_blur_far_quality(value)
getter	get_dof_blur_far_quality

• float dof_blur_far_transition

Default	5.0
setter	set_dof_blur_far_transition(value)
getter	get_dof_blur_far_transition

• float dof_blur_near_amount

Default	0.1
setter	set_dof_blur_near_amount(value)
getter	get_dof_blur_near_amount

• float dof_blur_near_distance

Default	2.0
setter	set_dof_blur_near_distance(value)
getter	get_dof_blur_near_distance

• bool dof_blur_near_enabled

Default	false
setter	set_dof_blur_near_enabled(value)
getter	is_dof_blur_near_enabled

• int dof_blur_near_quality

Default	1
setter	set_dof_blur_near_quality(value)
getter	get_dof_blur_near_quality

• float dof_blur_near_transition

Default	1.0
setter	set_dof_blur_near_transition(value)
getter	get_dof_blur_near_transition

• Color fog_color

Default	Color( 0.5, 0.6, 0.7, 1 )
setter	set_fog_color(value)
getter	get_fog_color

• float fog_depth_begin

Default	10.0
setter	set_fog_depth_begin(value)
getter	get_fog_depth_begin

• float fog_depth_curve

Default	1.0
setter	set_fog_depth_curve(value)
getter	get_fog_depth_curve

• bool fog_depth_enabled

Default	true
setter	set_fog_depth_enabled(value)
getter	is_fog_depth_enabled

• float fog_depth_end

Default	100.0
setter	set_fog_depth_end(value)
getter	get_fog_depth_end

• bool fog_enabled

Default	false
setter	set_fog_enabled(value)
getter	is_fog_enabled

• float fog_height_curve

Default	1.0
setter	set_fog_height_curve(value)
getter	get_fog_height_curve

• bool fog_height_enabled

Default	false
setter	set_fog_height_enabled(value)
getter	is_fog_height_enabled

• float fog_height_max

Default	0.0
setter	set_fog_height_max(value)
getter	get_fog_height_max

• float fog_height_min

Default	10.0
setter	set_fog_height_min(value)
getter	get_fog_height_min

• float fog_sun_amount

Default	0.0
setter	set_fog_sun_amount(value)
getter	get_fog_sun_amount

• Color fog_sun_color

Default	Color( 1, 0.9, 0.7, 1 )
setter	set_fog_sun_color(value)
getter	get_fog_sun_color

• float fog_transmit_curve

Default	1.0
setter	set_fog_transmit_curve(value)
getter	get_fog_transmit_curve

• bool fog_transmit_enabled

Default	false
setter	set_fog_transmit_enabled(value)
getter	is_fog_transmit_enabled

• bool glow_bicubic_upscale

Default	false
setter	set_glow_bicubic_upscale(value)
getter	is_glow_bicubic_upscale_enabled

• int glow_blend_mode

Default	2
setter	set_glow_blend_mode(value)
getter	get_glow_blend_mode

• float glow_bloom

Default	0.0
setter	set_glow_bloom(value)
getter	get_glow_bloom

• bool glow_enabled

Default	false
setter	set_glow_enabled(value)
getter	is_glow_enabled

• float glow_hdr_luminance_cap

Default	12.0
setter	set_glow_hdr_luminance_cap(value)
getter	get_glow_hdr_luminance_cap

• float glow_hdr_scale

Default	2.0
setter	set_glow_hdr_bleed_scale(value)
getter	get_glow_hdr_bleed_scale

• float glow_hdr_threshold

Default	1.0
setter	set_glow_hdr_bleed_threshold(value)
getter	get_glow_hdr_bleed_threshold

• float glow_intensity

Default	0.8
setter	set_glow_intensity(value)
getter	get_glow_intensity

• bool glow_levels/1

Default	false
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/2

Default	false
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/3

Default	true
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/4

Default	false
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/5

Default	true
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/6

Default	false
setter	set_glow_level(value)
getter	is_glow_level_enabled

• bool glow_levels/7

Default	false
setter	set_glow_level(value)
getter	is_glow_level_enabled

• float glow_strength

Default	1.0
setter	set_glow_strength(value)
getter	get_glow_strength

• float ss_reflections_depth_tolerance

Default	0.2
setter	set_ssr_depth_tolerance(value)
getter	get_ssr_depth_tolerance

• bool ss_reflections_enabled

Default	false
setter	set_ssr_enabled(value)
getter	is_ssr_enabled

• float ss_reflections_fade_in

Default	0.15
setter	set_ssr_fade_in(value)
getter	get_ssr_fade_in

• float ss_reflections_fade_out

Default	2.0
setter	set_ssr_fade_out(value)
getter	get_ssr_fade_out

• int ss_reflections_max_steps

Default	64
setter	set_ssr_max_steps(value)
getter	get_ssr_max_steps

• bool ss_reflections_roughness

Default	true
setter	set_ssr_rough(value)
getter	is_ssr_rough

• float ssao_ao_channel_affect

Default	0.0
setter	set_ssao_ao_channel_affect(value)
getter	get_ssao_ao_channel_affect

• float ssao_bias

Default	0.01
setter	set_ssao_bias(value)
getter	get_ssao_bias

• int ssao_blur

Default	3
setter	set_ssao_blur(value)
getter	get_ssao_blur

• Color ssao_color

Default	Color( 0, 0, 0, 1 )
setter	set_ssao_color(value)
getter	get_ssao_color

• float ssao_edge_sharpness

Default	4.0
setter	set_ssao_edge_sharpness(value)
getter	get_ssao_edge_sharpness

• bool ssao_enabled

Default	false
setter	set_ssao_enabled(value)
getter	is_ssao_enabled

• float ssao_intensity

Default	1.0
setter	set_ssao_intensity(value)
getter	get_ssao_intensity

• float ssao_intensity2

Default	1.0
setter	set_ssao_intensity2(value)
getter	get_ssao_intensity2

• float ssao_light_affect

Default	0.0
setter	set_ssao_direct_light_affect(value)
getter	get_ssao_direct_light_affect

• int ssao_quality

Default	1
setter	set_ssao_quality(value)
getter	get_ssao_quality

• float ssao_radius

Default	1.0
setter	set_ssao_radius(value)
getter	get_ssao_radius

• float ssao_radius2

Default	0.0
setter	set_ssao_radius2(value)
getter	get_ssao_radius2

• float tonemap_exposure

Default	1.0
setter	set_tonemap_exposure(value)
getter	get_tonemap_exposure

• int tonemap_mode

Default	0
setter	set_tonemapper(value)
getter	get_tonemapper

• float tonemap_white

Default	1.0
setter	set_tonemap_white(value)
getter	get_tonemap_white

方法说明

• is_glow_level_enabled is_glow_level_enabled(idx: int) const

如果指定发光级别idx，则返回true，否则返回false。

---

• set_glow_level set_glow_level(idx: int, enabled: bool)

启用或禁用索引为idx的辉光级别。每个级别都依赖于上一个级别。这意味着启用较高的发光级别将降低发光效果的渲染速度，即使未启用先前的发光级别也是如此。

---