| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the FogVolume.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_FogVolume:
- FogVolume
- =========
- **Inherits:** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- A node used to add local fog with the volumetric fog effect.
- Description
- -----------
- ``FogVolume``\ s are used to add localized fog into the global volumetric fog effect.
- Performance of ``FogVolume``\ s is directly related to their relative size on the screen and the complexity of their attached :ref:`FogMaterial<class_FogMaterial>`. It is best to keep ``FogVolume``\ s relatively small and simple where possible.
- Properties
- ----------
- +------------------------------------------------------------+----------------------------------------------------+----------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`extents<class_FogVolume_property_extents>` | ``Vector3(1, 1, 1)`` |
- +------------------------------------------------------------+----------------------------------------------------+----------------------+
- | :ref:`Material<class_Material>` | :ref:`material<class_FogVolume_property_material>` | |
- +------------------------------------------------------------+----------------------------------------------------+----------------------+
- | :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` | :ref:`shape<class_FogVolume_property_shape>` | ``1`` |
- +------------------------------------------------------------+----------------------------------------------------+----------------------+
- Property Descriptions
- ---------------------
- .. _class_FogVolume_property_extents:
- - :ref:`Vector3<class_Vector3>` **extents**
- +-----------+----------------------+
- | *Default* | ``Vector3(1, 1, 1)`` |
- +-----------+----------------------+
- | *Setter* | set_extents(value) |
- +-----------+----------------------+
- | *Getter* | get_extents() |
- +-----------+----------------------+
- Sets the size of the ``FogVolume`` when :ref:`shape<class_FogVolume_property_shape>` is :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`.
- \ **Note:** Thin fog volumes may appear to flicker when the camera moves or rotates. This can be alleviated by increasing :ref:`ProjectSettings.rendering/environment/volumetric_fog/volume_depth<class_ProjectSettings_property_rendering/environment/volumetric_fog/volume_depth>` (at a performance cost) or by decreasing :ref:`Environment.volumetric_fog_length<class_Environment_property_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 :ref:`material<class_FogVolume_property_material>`.
- ----
- .. _class_FogVolume_property_material:
- - :ref:`Material<class_Material>` **material**
- +----------+---------------------+
- | *Setter* | set_material(value) |
- +----------+---------------------+
- | *Getter* | get_material() |
- +----------+---------------------+
- Sets the :ref:`Material<class_Material>` to be used by the ``FogVolume``. Can be either a :ref:`FogMaterial<class_FogMaterial>` or a custom :ref:`ShaderMaterial<class_ShaderMaterial>`.
- ----
- .. _class_FogVolume_property_shape:
- - :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **shape**
- +-----------+------------------+
- | *Default* | ``1`` |
- +-----------+------------------+
- | *Setter* | set_shape(value) |
- +-----------+------------------+
- | *Getter* | get_shape() |
- +-----------+------------------+
- Sets the shape of the ``FogVolume`` to either :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`, or :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_WORLD<class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
