mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-27 09:16:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
e7cf2b2e77
godot/doc/classes/Environment.xml

308 lines
16 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync with current source Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-25 15:50:56 +08:00
<class name="Environment" inherits="Resource" category="Core" version="3.0-stable">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</brief_description>
<description>
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
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
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 16:03:59 +08:00
http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html
http://docs.godotengine.org/en/3.0/tutorials/3d/high_dynamic_range.html
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="adjustment_brightness" type="float" setter="set_adjustment_brightness" getter="get_adjustment_brightness">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Global brightness value of the rendered scene (default value is 1).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="adjustment_color_correction" type="Texture" setter="set_adjustment_color_correction" getter="get_adjustment_color_correction">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Applies the provided [Texture] resource to affect the global color aspect of the rendered scene.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="adjustment_contrast" type="float" setter="set_adjustment_contrast" getter="get_adjustment_contrast">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Global contrast value of the rendered scene (default value is 1).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="adjustment_enabled" type="bool" setter="set_adjustment_enable" getter="is_adjustment_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="adjustment_saturation" type="float" setter="set_adjustment_saturation" getter="get_adjustment_saturation">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Global color saturation value of the rendered scene (default value is 1).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ambient_light_color" type="Color" setter="set_ambient_light_color" getter="get_ambient_light_color">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
[Color] of the ambient light.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ambient_light_energy" type="float" setter="set_ambient_light_energy" getter="get_ambient_light_energy">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Energy of the ambient light. The higher the value, the stronger the light.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ambient_light_sky_contribution" type="float" setter="set_ambient_light_sky_contribution" getter="get_ambient_light_sky_contribution">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="auto_exposure_enabled" type="bool" setter="set_tonemap_auto_exposure" getter="get_tonemap_auto_exposure">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="auto_exposure_max_luma" type="float" setter="set_tonemap_auto_exposure_max" getter="get_tonemap_auto_exposure_max">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Maximum luminance value for the auto exposure.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="auto_exposure_min_luma" type="float" setter="set_tonemap_auto_exposure_min" getter="get_tonemap_auto_exposure_min">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Minimum luminance value for the auto exposure.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="auto_exposure_scale" type="float" setter="set_tonemap_auto_exposure_grey" getter="get_tonemap_auto_exposure_grey">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Scale of the auto exposure effect. Affects the intensity of auto exposure.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="auto_exposure_speed" type="float" setter="set_tonemap_auto_exposure_speed" getter="get_tonemap_auto_exposure_speed">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="background_canvas_max_layer" type="int" setter="set_canvas_max_layer" getter="get_canvas_max_layer">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Maximum layer id (if using Layer background mode).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="background_color" type="Color" setter="set_bg_color" getter="get_bg_color">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="background_energy" type="float" setter="set_bg_energy" getter="get_bg_energy">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Power of light emitted by the background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="background_mode" type="int" setter="set_background" getter="get_background" enum="Environment.BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Defines the mode of background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="background_sky" type="Sky" setter="set_sky" getter="get_sky">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
[Sky] resource defined as background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-12 05:54:43 +08:00
<member name="background_sky_custom_fov" type="float" setter="set_sky_custom_fov" getter="get_sky_custom_fov">
[Sky] resource's custom field of view.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_far_amount" type="float" setter="set_dof_blur_far_amount" getter="get_dof_blur_far_amount">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Amount of far blur.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_far_distance" type="float" setter="set_dof_blur_far_distance" getter="get_dof_blur_far_distance">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Distance from the camera where the far blur effect affects the rendering.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_far_enabled" type="bool" setter="set_dof_blur_far_enabled" getter="is_dof_blur_far_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the far blur effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_far_quality" type="int" setter="set_dof_blur_far_quality" getter="get_dof_blur_far_quality" enum="Environment.DOFBlurQuality">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Quality of the far blur quality.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_far_transition" type="float" setter="set_dof_blur_far_transition" getter="get_dof_blur_far_transition">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Transition between no-blur area and far blur.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_near_amount" type="float" setter="set_dof_blur_near_amount" getter="get_dof_blur_near_amount">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Amount of near blur.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_near_distance" type="float" setter="set_dof_blur_near_distance" getter="get_dof_blur_near_distance">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Distance from the camera where the near blur effect affects the rendering.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_near_enabled" type="bool" setter="set_dof_blur_near_enabled" getter="is_dof_blur_near_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the near blur effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_near_quality" type="int" setter="set_dof_blur_near_quality" getter="get_dof_blur_near_quality" enum="Environment.DOFBlurQuality">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Quality of the near blur quality.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="dof_blur_near_transition" type="float" setter="set_dof_blur_near_transition" getter="get_dof_blur_near_transition">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Transition between near blur and no-blur area.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_color" type="Color" setter="set_fog_color" getter="get_fog_color">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Fog's [Color].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_depth_begin" type="float" setter="set_fog_depth_begin" getter="get_fog_depth_begin">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Fog's depth starting distance from the camera.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_depth_curve" type="float" setter="set_fog_depth_curve" getter="get_fog_depth_curve">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Value defining the fog depth intensity.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the fog depth.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Value defining the fog height intensity.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_height_enabled" type="bool" setter="set_fog_height_enabled" getter="is_fog_height_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables the fog height.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_height_max" type="float" setter="set_fog_height_max" getter="get_fog_height_max">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Maximum height of fog.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_height_min" type="float" setter="set_fog_height_min" getter="get_fog_height_min">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Minimum height of fog.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_sun_amount" type="float" setter="set_fog_sun_amount" getter="get_fog_sun_amount">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Amount of sun that affects the fog rendering.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_sun_color" type="Color" setter="set_fog_sun_color" getter="get_fog_sun_color">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Sun [Color].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_transmit_curve" type="float" setter="set_fog_transmit_curve" getter="get_fog_transmit_curve">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Amount of light that the fog transmits.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="fog_transmit_enabled" type="bool" setter="set_fog_transmit_enabled" getter="is_fog_transmit_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_bicubic_upscale" type="bool" setter="set_glow_bicubic_upscale" getter="is_glow_bicubic_upscale_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_blend_mode" type="int" setter="set_glow_blend_mode" getter="get_glow_blend_mode" enum="Environment.GlowBlendMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Glow blending mode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_bloom" type="float" setter="set_glow_bloom" getter="get_glow_bloom">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Bloom value (global glow).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_enabled" type="bool" setter="set_glow_enabled" getter="is_glow_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Enables glow rendering.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_hdr_scale" type="float" setter="set_glow_hdr_bleed_scale" getter="get_glow_hdr_bleed_scale">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Bleed scale of the HDR glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_hdr_threshold" type="float" setter="set_glow_hdr_bleed_threshold" getter="get_glow_hdr_bleed_threshold">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Bleed threshold of the HDR glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_intensity" type="float" setter="set_glow_intensity" getter="get_glow_intensity">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Glow intensity.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/1" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
First level of glow (most local).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/2" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Second level of glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/3" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Third level of glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/4" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Fourth level of glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/5" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Fifth level of glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/6" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Sixth level of glow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_levels/7" type="bool" setter="set_glow_level" getter="is_glow_level_enabled">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Seventh level of glow (most global).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="glow_strength" type="float" setter="set_glow_strength" getter="get_glow_strength">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Glow strength.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_depth_tolerance" type="float" setter="set_ssr_depth_tolerance" getter="get_ssr_depth_tolerance">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_enabled" type="bool" setter="set_ssr_enabled" getter="is_ssr_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_fade_in" type="float" setter="set_ssr_fade_in" getter="get_ssr_fade_in">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_fade_out" type="float" setter="set_ssr_fade_out" getter="get_ssr_fade_out">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_max_steps" type="int" setter="set_ssr_max_steps" getter="get_ssr_max_steps">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ss_reflections_roughness" type="bool" setter="set_ssr_rough" getter="is_ssr_rough">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
<member name="ssao_blur" type="int" setter="set_ssao_blur" getter="is_ssao_blur_enabled" enum="Environment.SSAOBlur">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_color" type="Color" setter="set_ssao_color" getter="get_ssao_color">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
<member name="ssao_edge_sharpness" type="float" setter="set_ssao_edge_sharpness" getter="get_ssao_edge_sharpness">
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_enabled" type="bool" setter="set_ssao_enabled" getter="is_ssao_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_intensity" type="float" setter="set_ssao_intensity" getter="get_ssao_intensity">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_intensity2" type="float" setter="set_ssao_intensity2" getter="get_ssao_intensity2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_light_affect" type="float" setter="set_ssao_direct_light_affect" getter="get_ssao_direct_light_affect">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
<member name="ssao_quality" type="int" setter="set_ssao_quality" getter="get_ssao_quality" enum="Environment.SSAOQuality">
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_radius" type="float" setter="set_ssao_radius" getter="get_ssao_radius">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="ssao_radius2" type="float" setter="set_ssao_radius2" getter="get_ssao_radius2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="tonemap_exposure" type="float" setter="set_tonemap_exposure" getter="get_tonemap_exposure">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Default exposure for tonemap.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="tonemap_mode" type="int" setter="set_tonemapper" getter="get_tonemapper" enum="Environment.ToneMapper">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Tonemapping mode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="tonemap_white" type="float" setter="set_tonemap_white" getter="get_tonemap_white">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
White reference value for tonemap.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_KEEP" value="5" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Keep on screen every pixel drawn in the background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_CLEAR_COLOR" value="0" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Clear the background using the project's clear color.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_COLOR" value="1" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Clear the background using a custom clear color.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_SKY" value="2" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Display a user-defined sky in the background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_COLOR_SKY" value="3" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Clear the background using a custom clear color and allows defining a sky for shading and reflection.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_CANVAS" value="4" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Display a [CanvasLayer] in the background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="BG_MAX" value="6" enum="BGMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Helper constant keeping track of the enum's size, has no direct usage in API calls.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="GLOW_BLEND_MODE_ADDITIVE" value="0" enum="GlowBlendMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="GLOW_BLEND_MODE_SCREEN" value="1" enum="GlowBlendMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Screen glow blending mode. Increases brightness, used frequently with bloom.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="GlowBlendMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="GLOW_BLEND_MODE_REPLACE" value="3" enum="GlowBlendMode">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Replace glow blending mode. Replaces all pixels' color by the glow value.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="TONE_MAPPER_LINEAR" value="0" enum="ToneMapper">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="TONE_MAPPER_FILMIC" value="2" enum="ToneMapper">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Filmic tonemapper operator.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="TONE_MAPPER_ACES" value="3" enum="ToneMapper">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Academy Color Encoding System tonemapper operator.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DOF_BLUR_QUALITY_LOW" value="0" enum="DOFBlurQuality">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Low depth-of-field blur quality.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DOF_BLUR_QUALITY_MEDIUM" value="1" enum="DOFBlurQuality">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
Medium depth-of-field blur quality.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DOF_BLUR_QUALITY_HIGH" value="2" enum="DOFBlurQuality">
Partial documentation for Environment resource.
2017-09-23 19:59:30 +08:00
High depth-of-field blur quality.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_BLUR_DISABLED" value="0" enum="SSAOBlur">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_BLUR_1x1" value="1" enum="SSAOBlur">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_BLUR_2x2" value="2" enum="SSAOBlur">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_BLUR_3x3" value="3" enum="SSAOBlur">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_QUALITY_LOW" value="0" enum="SSAOQuality">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_QUALITY_MEDIUM" value="1" enum="SSAOQuality">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="SSAO_QUALITY_HIGH" value="2" enum="SSAOQuality">
classref: Sync with current source [ci skip]
2017-10-25 01:22:37 +08:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constants>
</class>
Reference in New Issue Copy Permalink