summaryrefslogtreecommitdiff
path: root/doc/classes/WorldEnvironment.xml
blob: e68ad2800e79bfc3305f7f4bc51a082f455cc4d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WorldEnvironment" inherits="Node" category="Core" version="3.1">
	<brief_description>
		Default environment properties for the entire scene (post-processing effects, lightning and background settings).
	</brief_description>
	<description>
		The [code]WorldEnvironment[/code] node is used to configure the default [Environment] for the scene.
		The parameters defined in the [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time.
		The [code]WorldEnvironment[/code] 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.
	</description>
	<tutorials>
		<link>http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
			The [Environment] resource used by this [code]WorldEnvironment[/code], defining the default properties.
		</member>
	</members>
	<constants>
	</constants>
</class>