mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
55 lines
2.0 KiB
ReStructuredText
55 lines
2.0 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_WorldEnvironment:
|
|
|
|
WorldEnvironment
|
|
================
|
|
|
|
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Default environment properties for the entire scene (post-processing effects, lighting and background settings).
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------+--------------------------------------------------------+
|
|
| :ref:`Environment<class_Environment>` | :ref:`environment<class_WorldEnvironment_environment>` |
|
|
+---------------------------------------+--------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
The ``WorldEnvironment`` node is used to configure the default :ref:`Environment<class_Environment>` for the scene.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/3d/environment_and_post_processing`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_WorldEnvironment_environment:
|
|
|
|
- :ref:`Environment<class_Environment>` **environment**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_environment(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_environment() |
|
|
+----------+------------------------+
|
|
|
|
The :ref:`Environment<class_Environment>` resource used by this ``WorldEnvironment``, defining the default properties.
|
|
|