From 75d95fca7902a31de51543b677fb56d4c1983246 Mon Sep 17 00:00:00 2001 From: Julian Murgia Date: Sat, 23 Sep 2017 13:59:30 +0200 Subject: [PATCH] Partial documentation for Environment resource. --- doc/classes/Environment.xml | 86 ++++++++++++++++++++++++++++++++++++- 1 file changed, 85 insertions(+), 1 deletion(-) diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 4338b188a6e..3880c45a86c 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -1,8 +1,15 @@ - + + Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options. + Resource for environment nodes (like [WorldEnvironment]) that define multiple environment operations (such as background [Sky] or [Color], ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: + - DOF Blur + - Motion Blur + - Bloom + - Tonemap (auto exposure) + - Adjustments @@ -982,118 +989,174 @@ + Global brightness value of the rendered scene (default value is 1). + Applies the provided [Texture] resource to affect the global color aspect of the rendered scene. + Global contrast value of the rendered scene (default value is 1). + Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. + Global color saturation value of the rendered scene (default value is 1). + [Color] of the ambient light. + Energy of the ambient light. The higher the value, the stronger the light. + Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. + Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. + Maximum luminance value for the auto exposure. + Minimum luminance value for the auto exposure. + Scale of the auto exposure effect. Affects the intensity of auto exposure. + Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. + Maximum layer id (if using Layer background mode). + Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). + Power of light emitted by the background. + Defines the mode of background. + [Sky] resource defined as background. + [Sky] resource's scale. + Amount of far blur. + Distance from the camera where the far blur effect affects the rendering. + Enables the far blur effect. + Quality of the far blur quality. + Transition between no-blur area and far blur. + Amount of near blur. + Distance from the camera where the near blur effect affects the rendering. + Enables the near blur effect. + Quality of the near blur quality. + Transition between near blur and no-blur area. + Fog's [Color]. + Fog's depth starting distance from the camera. + Value defining the fog depth intensity. + Enables the fog depth. + Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. + Value defining the fog height intensity. + Enables the fog height. + Maximum height of fog. + Minimum height of fog. + Amount of sun that affects the fog rendering. + Sun [Color]. + Amount of light that the fog transmits. + Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. + Glow blending mode. + Bloom value (global glow). + Enables glow rendering. + Bleed scale of the HDR glow. + Bleed threshold of the HDR glow. + Glow intensity. + First level of glow (most local). + Second level of glow. + Third level of glow. + Fourth level of glow. + Fifth level of glow. + Sixth level of glow. + Seventh level of glow (most global). + Glow strength. @@ -1126,48 +1189,69 @@ + Default exposure for tonemap. + Tonemapping mode. + White reference value for tonemap. + Keep on screen every pixel drawn in the background. + Clear the background using the project's clear color. + Clear the background using a custom clear color. + Display a user-defined sky in the background. + Clear the background using a custom clear color and allows defining a sky for shading and reflection. + Display a [CanvasLayer] in the background. + Helper constant keeping track of the enum's size, has no direct usage in API calls. + Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. + Screen glow blending mode. Increases brightness, used frequently with bloom. + Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. + Replace glow blending mode. Replaces all pixels' color by the glow value. + Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. + Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color). + Filmic tonemapper operator. + Academy Color Encoding System tonemapper operator. + Low depth-of-field blur quality. + Medium depth-of-field blur quality. + High depth-of-field blur quality.