Class FogVolume

A region that contributes to the default volumetric fog from the world environment.

Inheritance

VisualInstance3D

Node3D

Node

Object

FogVolume

Remarks

FogVolumes are used to add localized fog into the global volumetric fog effect. FogVolumes can also remove volumetric fog from specific areas if using a FogMaterial with a negative density.

Performance of FogVolumes is directly related to their relative size on the screen and the complexity of their attached FogMaterial. It is best to keep FogVolumes relatively small and simple where possible.

Note: FogVolumes only have a visible effect if volumetric_fog_enabled is true. If you don't want fog to be globally visible (but only within FogVolume nodes), set volumetric_fog_density to 0.0.

See Also

Volumetric fog and fog volumes

Properties

material

The Material used by the FogVolume. Can be either a built-in FogMaterial or a custom ShaderMaterial.

var material : Material

Property Value

Material

Remarks

• void set_material(Material value)
• Material get_material

shape

The shape of the FogVolume. This can be set to either RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID, RenderingServer.FOG_VOLUME_SHAPE_CONE, RenderingServer.FOG_VOLUME_SHAPE_CYLINDER, RenderingServer.FOG_VOLUME_SHAPE_BOX or RenderingServer.FOG_VOLUME_SHAPE_WORLD.

var shape : int = 3

Property Value

int

Remarks

• void set_shape(int value)
• int get_shape

size

The size of the FogVolume when shape is RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID, RenderingServer.FOG_VOLUME_SHAPE_CONE, RenderingServer.FOG_VOLUME_SHAPE_CYLINDER or RenderingServer.FOG_VOLUME_SHAPE_BOX.

Note: Thin fog volumes may appear to flicker when the camera moves or rotates. This can be alleviated by increasing rendering/environment/volumetric_fog/volume_depth (at a performance cost) or by decreasing volumetric_fog_length (at no performance cost, but at the cost of lower fog range). Alternatively, the FogVolume can be made thicker and use a lower density in the material.

Note: If shape is RenderingServer.FOG_VOLUME_SHAPE_CONE or RenderingServer.FOG_VOLUME_SHAPE_CYLINDER, the cone/cylinder will be adjusted to fit within the size. Non-uniform scaling of cone/cylinder shapes via the size property is not supported, but you can scale the FogVolume node instead.

var size : Vector3 = Vector3(2, 2, 2)

Property Value

Vector3

Remarks

• void set_size(Vector3 value)
• Vector3 get_size