asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added descriptions for WorldEnvironment node in documentation

Browse source
This commit is contained in:
clayjohn 2017-04-24 12:51:27 -06:00
parent b6e0eaf3ca
commit 5fdc7ac88a
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/base/classes.xml
View file

@ -51969,20 +51969,24 @@ do_property].
</class>
<class name="WorldEnvironment" inherits="Spatial" category="Core">
<brief_description>
Sets environment properties for the entire scene
</brief_description>
<description>
The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [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).
</description>
<methods>
<method name="get_environment" qualifiers="const">
<return type="Environment">
</return>
<description>
Return the [Environment] currently bound.
</description>
</method>
<method name="set_environment">
<argument index="0" name="env" type="Environment">
</argument>
<description>
Set the currently bound [Environment] to the one specified.
</description>
</method>
</methods>
@ -52307,3 +52311,4 @@ do_property].
</constants>
</class>
</doc>