| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- .. 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
- -----------------
- Sets environment properties for the entire scene
- Member Functions
- ----------------
- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Environment<class_environment>` | :ref:`get_environment<class_WorldEnvironment_get_environment>` **(** **)** const |
- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_environment<class_WorldEnvironment_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`Environment<class_environment>` **environment**
- Description
- -----------
- The :ref:`WorldEnvironment<class_worldenvironment>` node can be added to a scene in order to set default :ref:`Environment<class_environment>` variables for the scene. The :ref:`WorldEnvironment<class_worldenvironment>` can be overridden by an :ref:`Environment<class_environment>` node set on the current :ref:`Camera<class_camera>`. Additionally, only one :ref:`WorldEnvironment<class_worldenvironment>` may be instanced in a given scene at a time. The :ref:`WorldEnvironment<class_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).
- Member Function Description
- ---------------------------
- .. _class_WorldEnvironment_get_environment:
- - :ref:`Environment<class_environment>` **get_environment** **(** **)** const
- Return the :ref:`Environment<class_environment>` currently bound.
- .. _class_WorldEnvironment_set_environment:
- - void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
- Set the currently bound :ref:`Environment<class_environment>` to the one specified.
|
