Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_fogvolume.rst

class_fogvolume.rst 7.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FogVolume.xml.
    7. 

  7. 

  8. .. _class_FogVolume:
    9. 

  9. 

  10. FogVolume
    11. 

  11. =========
    12. 

  12. 

  13. **Inherits:** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

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

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. **FogVolume**\ s are used to add localized fog into the global volumetric fog effect. **FogVolume**\ s can also remove volumetric fog from specific areas if using a :ref:`FogMaterial<class_FogMaterial>` with a negative :ref:`FogMaterial.density<class_FogMaterial_property_density>`.
    23. 

  23. 

  24. 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.
    25. 

  25. 

  26. \ **Note:** **FogVolume**\ s only have a visible effect if :ref:`Environment.volumetric_fog_enabled<class_Environment_property_volumetric_fog_enabled>` is ``true``. If you don't want fog to be globally visible (but only within **FogVolume** nodes), set :ref:`Environment.volumetric_fog_density<class_Environment_property_volumetric_fog_density>` to ``0.0``.
    27. 

  27. 

  28. .. rst-class:: classref-introduction-group
    29. 

  29. 

  30. Tutorials
    31. 

  31. ---------
    32. 

  32. 

  33. - :doc:`Volumetric fog and fog volumes <../tutorials/3d/volumetric_fog>`
    34. 

  34. 

  35. .. rst-class:: classref-reftable-group
    36. 

  36. 

  37. Properties
    38. 

  38. ----------
    39. 

  39. 

  40. .. table::
    41. 

  41.    :widths: auto
    42. 

  42. 

  43.    +------------------------------------------------------------+----------------------------------------------------+----------------------+
    44. 

  44.    | :ref:`Material<class_Material>`                            | :ref:`material<class_FogVolume_property_material>` |                      |
    45. 

  45.    +------------------------------------------------------------+----------------------------------------------------+----------------------+
    46. 

  46.    | :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` | :ref:`shape<class_FogVolume_property_shape>`       | ``3``                |
    47. 

  47.    +------------------------------------------------------------+----------------------------------------------------+----------------------+
    48. 

  48.    | :ref:`Vector3<class_Vector3>`                              | :ref:`size<class_FogVolume_property_size>`         | ``Vector3(2, 2, 2)`` |
    49. 

  49.    +------------------------------------------------------------+----------------------------------------------------+----------------------+
    50. 

  50. 

  51. .. rst-class:: classref-section-separator
    52. 

  52. 

  53. ----
    54. 

  54. 

  55. .. rst-class:: classref-descriptions-group
    56. 

  56. 

  57. Property Descriptions
    58. 

  58. ---------------------
    59. 

  59. 

  60. .. _class_FogVolume_property_material:
    61. 

  61. 

  62. .. rst-class:: classref-property
    63. 

  63. 

  64. :ref:`Material<class_Material>` **material** :ref:`🔗<class_FogVolume_property_material>`
    65. 

  65. 

  66. .. rst-class:: classref-property-setget
    67. 

  67. 

  68. - |void| **set_material**\ (\ value\: :ref:`Material<class_Material>`\ )
    69. 

  69. - :ref:`Material<class_Material>` **get_material**\ (\ )
    70. 

  70. 

  71. The :ref:`Material<class_Material>` used by the **FogVolume**. Can be either a built-in :ref:`FogMaterial<class_FogMaterial>` or a custom :ref:`ShaderMaterial<class_ShaderMaterial>`.
    72. 

  72. 

  73. .. rst-class:: classref-item-separator
    74. 

  74. 

  75. ----
    76. 

  76. 

  77. .. _class_FogVolume_property_shape:
    78. 

  78. 

  79. .. rst-class:: classref-property
    80. 

  80. 

  81. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **shape** = ``3`` :ref:`🔗<class_FogVolume_property_shape>`
    82. 

  82. 

  83. .. rst-class:: classref-property-setget
    84. 

  84. 

  85. - |void| **set_shape**\ (\ value\: :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>`\ )
    86. 

  86. - :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **get_shape**\ (\ )
    87. 

  87. 

  88. The shape of the **FogVolume**. This can be set to either :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_WORLD<class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD>`.
    89. 

  89. 

  90. .. rst-class:: classref-item-separator
    91. 

  91. 

  92. ----
    93. 

  93. 

  94. .. _class_FogVolume_property_size:
    95. 

  95. 

  96. .. rst-class:: classref-property
    97. 

  97. 

  98. :ref:`Vector3<class_Vector3>` **size** = ``Vector3(2, 2, 2)`` :ref:`🔗<class_FogVolume_property_size>`
    99. 

  99. 

  100. .. rst-class:: classref-property-setget
    101. 

  101. 

  102. - |void| **set_size**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
    103. 

  103. - :ref:`Vector3<class_Vector3>` **get_size**\ (\ )
    104. 

  104. 

  105. 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>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE>`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER>` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`.
    106. 

  106. 

  107. \ **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>`.
    108. 

  108. 

  109. \ **Note:** If :ref:`shape<class_FogVolume_property_shape>` is :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE>` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER>`, the cone/cylinder will be adjusted to fit within the size. Non-uniform scaling of cone/cylinder shapes via the :ref:`size<class_FogVolume_property_size>` property is not supported, but you can scale the **FogVolume** node instead.
    110. 

  110. 

  111. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    112. 

  112. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    113. 

  113. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    114. 

  114. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    115. 

  115. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    116. 

  116. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    117. 

  117. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    118. 

  118. .. |void| replace:: :abbr:`void (No return value.)`
    119. 

  119.