mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-07 02:12:07 +03:00
140 lines
6.7 KiB
ReStructuredText
140 lines
6.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FogMaterial.xml.
|
|
|
|
.. _class_FogMaterial:
|
|
|
|
FogMaterial
|
|
===========
|
|
|
|
**Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
:ref:`Material<class_Material>` used with a :ref:`FogVolume<class_FogVolume>` to draw things with the volumetric fog effect.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A :ref:`Material<class_Material>` resource that can be used by :ref:`FogVolume<class_FogVolume>`\ s to draw volumetric effects.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`albedo<class_FogMaterial_property_albedo>` | ``Color(1, 1, 1, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`density<class_FogMaterial_property_density>` | ``1.0`` |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Texture3D<class_Texture3D>` | :ref:`density_texture<class_FogMaterial_property_density_texture>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`edge_fade<class_FogMaterial_property_edge_fade>` | ``0.1`` |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`emission<class_FogMaterial_property_emission>` | ``Color(0, 0, 0, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`height_falloff<class_FogMaterial_property_height_falloff>` | ``0.0`` |
|
|
+-----------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_FogMaterial_property_albedo:
|
|
|
|
- :ref:`Color<class_Color>` **albedo**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``Color(1, 1, 1, 1)`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_albedo(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_albedo() |
|
|
+-----------+-----------------------+
|
|
|
|
Sets the single-scattering :ref:`Color<class_Color>` of the :ref:`FogVolume<class_FogVolume>`. Internally :ref:`albedo<class_FogMaterial_property_albedo>` is converted into single-scattering which is additively blended with other :ref:`FogVolume<class_FogVolume>`\ s and the :ref:`Environment.volumetric_fog_albedo<class_Environment_property_volumetric_fog_albedo>`.
|
|
|
|
----
|
|
|
|
.. _class_FogMaterial_property_density:
|
|
|
|
- :ref:`float<class_float>` **density**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_density(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_density() |
|
|
+-----------+--------------------+
|
|
|
|
Sets the density of the :ref:`FogVolume<class_FogVolume>`. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes.
|
|
|
|
----
|
|
|
|
.. _class_FogMaterial_property_density_texture:
|
|
|
|
- :ref:`Texture3D<class_Texture3D>` **density_texture**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_density_texture(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_density_texture() |
|
|
+----------+----------------------------+
|
|
|
|
Sets a 3D texture that is used to scale the :ref:`density<class_FogMaterial_property_density>` of the :ref:`FogVolume<class_FogVolume>`.
|
|
|
|
----
|
|
|
|
.. _class_FogMaterial_property_edge_fade:
|
|
|
|
- :ref:`float<class_float>` **edge_fade**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``0.1`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_edge_fade(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_edge_fade() |
|
|
+-----------+----------------------+
|
|
|
|
Sets the hardness of the edges of the :ref:`FogVolume<class_FogVolume>`. A higher number will result in softer edges while a lower number will result in harder edges.
|
|
|
|
----
|
|
|
|
.. _class_FogMaterial_property_emission:
|
|
|
|
- :ref:`Color<class_Color>` **emission**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``Color(0, 0, 0, 1)`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_emission(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_emission() |
|
|
+-----------+-----------------------+
|
|
|
|
Sets the :ref:`Color<class_Color>` of the light emitted by the :ref:`FogVolume<class_FogVolume>`. Emitted light will not cast light or shadows on other objects, but can be useful for modulating the :ref:`Color<class_Color>` of the :ref:`FogVolume<class_FogVolume>` independently from light sources.
|
|
|
|
----
|
|
|
|
.. _class_FogMaterial_property_height_falloff:
|
|
|
|
- :ref:`float<class_float>` **height_falloff**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_height_falloff(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_height_falloff() |
|
|
+-----------+---------------------------+
|
|
|
|
Sets the rate by which the height-based fog decreases in density as height increases in world space. A high falloff will result in a sharp transition, while a low falloff will result in a smoother transition. A value of ``0`` results in uniform-density fog. The height threshold is determined by the height of the associated :ref:`FogVolume<class_FogVolume>`.
|
|
|
|
.. |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.)`
|