FogMaterial.xml 2.2 KB

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="FogMaterial" inherits="Material" version="4.0">
  3. <brief_description>
  4. [Material] used with a [FogVolume] to draw things with the volumetric fog effect.
  5. </brief_description>
  6. <description>
  7. A [Material] resource that can be used by [FogVolume]s to draw volumetric effects.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <members>
  12. <member name="albedo" type="Color" setter="set_albedo" getter="get_albedo" default="Color(1, 1, 1, 1)">
  13. Sets the single-scattering [Color] of the [FogVolume]. Internally [member albedo] is converted into single-scattering which is additively blended with other [FogVolume]s and the [member Environment.volumetric_fog_albedo].
  14. </member>
  15. <member name="density" type="float" setter="set_density" getter="get_density" default="1.0">
  16. Sets the density of the [FogVolume]. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes.
  17. </member>
  18. <member name="density_texture" type="Texture3D" setter="set_density_texture" getter="get_density_texture">
  19. Sets a 3D texture that is used to scale the [member density] of the [FogVolume].
  20. </member>
  21. <member name="edge_fade" type="float" setter="set_edge_fade" getter="get_edge_fade" default="0.1">
  22. Sets the hardness of the edges of the [FogVolume]. A higher number will result in softer edges while a lower number will result in harder edges.
  23. </member>
  24. <member name="emission" type="Color" setter="set_emission" getter="get_emission" default="Color(0, 0, 0, 1)">
  25. Sets the [Color] of the light emitted by the [FogVolume]. Emitted light will not cast light or shadows on other objects, but can be useful for modulating the [Color] of the [FogVolume] independently from light sources.
  26. </member>
  27. <member name="height_falloff" type="float" setter="set_height_falloff" getter="get_height_falloff" default="0.0">
  28. 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 [code]0[/code] results in uniform-density fog. The height threshold is determined by the height of the associated [FogVolume].
  29. </member>
  30. </members>
  31. </class>