FogVolume

Inherits: VisualInstance3D < Node3D < Node < Object

A node used to add local fog with the volumetric fog effect.

Description

FogVolumes are used to add localized fog into the global volumetric fog effect.

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.

Properties

Vector3

extents

Vector3(1, 1, 1)

Material

material

FogVolumeShape

shape

1

Property Descriptions

Default

Vector3(1, 1, 1)

Setter

set_extents(value)

Getter

get_extents()

Sets the size of the FogVolume when shape is RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID or RenderingServer.FOG_VOLUME_SHAPE_BOX.


Setter

set_material(value)

Getter

get_material()

Sets the Material to be used by the FogVolume. Can be either a FogMaterial or a custom ShaderMaterial.


Default

1

Setter

set_shape(value)

Getter

get_shape()

Sets the shape of the FogVolume to either RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID, RenderingServer.FOG_VOLUME_SHAPE_BOX, or RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID or RenderingServer.FOG_VOLUME_SHAPE_WORLD.