Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2c645c823e
Branches Tags
godot-docs
/
classes
/
class_worldenvironment.rst

class_worldenvironment.rst 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_WorldEnvironment:
    6. 

  6. 

  7. WorldEnvironment
    8. 

  8. ================
    9. 

  9. 

  10. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Default environment properties for the entire scene (post-processing effects, lighting and background settings).
    18. 

  18. 

  19. Properties
    20. 

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

  21. 

  22. +---------------------------------------+-----------------------------------------------------------------+
    23. 

  23. | :ref:`Environment<class_Environment>` | :ref:`environment<class_WorldEnvironment_property_environment>` |
    24. 

  24. +---------------------------------------+-----------------------------------------------------------------+
    25. 

  25. 

  26. Description
    27. 

  27. -----------
    28. 

  28. 

  29. The ``WorldEnvironment`` node is used to configure the default :ref:`Environment<class_Environment>` for the scene.
    30. 

  30. 

  31. The parameters defined in the ``WorldEnvironment`` can be overridden by an :ref:`Environment<class_Environment>` node set on the current :ref:`Camera<class_Camera>`. Additionally, only one ``WorldEnvironment`` may be instanced in a given scene at a time.
    32. 

  32. 

  33. The ``WorldEnvironment`` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene.
    34. 

  34. 

  35. Tutorials
    36. 

  36. ---------
    37. 

  37. 

  38. - :doc:`../tutorials/3d/environment_and_post_processing`
    39. 

  39. 

  40. Property Descriptions
    41. 

  41. ---------------------
    42. 

  42. 

  43. .. _class_WorldEnvironment_property_environment:
    44. 

  44. 

  45. - :ref:`Environment<class_Environment>` **environment**
    46. 

  46. 

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

  48. | *Setter* | set_environment(value) |
    49. 

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

  50. | *Getter* | get_environment()      |
    51. 

  51. +----------+------------------------+
    52. 

  52. 

  53. The :ref:`Environment<class_Environment>` resource used by this ``WorldEnvironment``, defining the default properties.
    54. 

  54.