From 1a1303a948658053348cba15acfc81295ca36b4a Mon Sep 17 00:00:00 2001
From: Abhas Kumar Sinha <31654395+abhaskumarsinha@users.noreply.github.com>
Date: Wed, 17 Jan 2018 08:02:46 +0530
Subject: Update MultiMeshInstance and WorldEnvironment documentation
With some edits by @akien-mga.
---
doc/classes/MultiMeshInstance.xml | 4 +++-
doc/classes/WorldEnvironment.xml | 7 +++++--
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml
index e09327e2c9..2896f514aa 100644
--- a/doc/classes/MultiMeshInstance.xml
+++ b/doc/classes/MultiMeshInstance.xml
@@ -4,7 +4,8 @@
Node that instances a [MultiMesh].
- MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances).
+ [code]MultiMeshInstance[/code] is a specialized node to instance [GeometryInstance]s based on a [MultiMesh] resource.
+ This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands).
@@ -14,6 +15,7 @@
+ The [MultiMesh] resource that will be used and shared among all instances of the [code]MultiMeshInstance[/code].
diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml
index 06a24c98d9..3969a8c502 100644
--- a/doc/classes/WorldEnvironment.xml
+++ b/doc/classes/WorldEnvironment.xml
@@ -1,10 +1,12 @@
- Sets environment properties for the entire scene
+ Default environment properties for the entire scene (post-processing effects, lightning and background settings).
- The [code]WorldEnvironment[/code] node can be added to a scene in order to set default [Environment] variables for the scene. 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).
+ 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.
http://docs.godotengine.org/en/3.0/learning/features/3d/environment_and_post_processing.html
@@ -15,6 +17,7 @@
+ The [Environment] resource used by this [code]WorldEnvironment[/code], defining the default properties.
--
cgit v1.2.3