CameraEffects

Inherits: Resource < RefCounted < Object

Contains camera-specific effects such as depth of field and exposure override.

Description

Contains camera-specific effects such as depth of field and exposure override.

See also Environment for general 3D environment settings.

Properties

float	dof_blur_amount	0.1
float	dof_blur_far_distance	10.0
bool	dof_blur_far_enabled	false
float	dof_blur_far_transition	5.0
float	dof_blur_near_distance	2.0
bool	dof_blur_near_enabled	false
float	dof_blur_near_transition	1.0
float	override_exposure	1.0
bool	override_exposure_enabled	false

Property Descriptions

• float dof_blur_amount

Default	0.1
Setter	set_dof_blur_amount(value)
Getter	get_dof_blur_amount()

The amount of blur for both near and far depth-of-field effects. The amount of blur increases the radius of the blur effect, making the affected area blurrier. However, If the amount is too high, you might start to see lines appearing, especially when using a low quality blur.

---

• float dof_blur_far_distance

Default	10.0
Setter	set_dof_blur_far_distance(value)
Getter	get_dof_blur_far_distance()

The distance from the camera where the far blur effect affects the rendering.

---

• bool dof_blur_far_enabled

Default	false
Setter	set_dof_blur_far_enabled(value)
Getter	is_dof_blur_far_enabled()

If true, enables the depth-of-field far blur effect. This has a significant performance cost. Consider disabling it in scenes where there are no far away objects.

---

• float dof_blur_far_transition

Default	5.0
Setter	set_dof_blur_far_transition(value)
Getter	get_dof_blur_far_transition()

The length of the transition between the no-blur area and far blur.

---

• float dof_blur_near_distance

Default	2.0
Setter	set_dof_blur_near_distance(value)
Getter	get_dof_blur_near_distance()

Distance from the camera where the near blur effect affects the rendering.

---

• bool dof_blur_near_enabled

Default	false
Setter	set_dof_blur_near_enabled(value)
Getter	is_dof_blur_near_enabled()

If true, enables the depth-of-field near blur effect. This has a significant performance cost. Consider disabling it in scenes where there are no nearby objects.

---

• float dof_blur_near_transition

Default	1.0
Setter	set_dof_blur_near_transition(value)
Getter	get_dof_blur_near_transition()

The length of the transition between the near blur and no-blur area.

---

• float override_exposure

Default	1.0
Setter	set_override_exposure(value)
Getter	get_override_exposure()

The exposure override value to use. Higher values will result in a brighter scene. Only effective if override_exposure_enabled is true.

---

• bool override_exposure_enabled

Default	false
Setter	set_override_exposure_enabled(value)
Getter	is_override_exposure_enabled()

If true, overrides the manual or automatic exposure defined in the Environment with the value in override_exposure.