Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas Szepe <HG1_public@gmx.net>2015-03-23 23:40:11 +0300
committerThomas Szepe <HG1_public@gmx.net>2015-03-23 23:40:11 +0300
commitd07c666a0e542517914dad580d1b3f4787525852 (patch)
tree4f9c2c5999817acaca97351e72e71f3f19cb7652 /doc
parent2affbb437bd3cbf3e1a502bd65a5eefb64a92b9b (diff)
BGE: Add setMistType and setMistIntensity API.
This patch adds the missing setMistType() and setMistIntensity() to the API Reviewers: campbellbarton, brecht, moguri Reviewed By: campbellbarton, brecht, moguri Subscribers: campbellbarton, dingto Differential Revision: https://developer.blender.org/D149
Diffstat (limited to 'doc')
-rw-r--r--doc/python_api/rst/bge.render.rst39
1 files changed, 33 insertions, 6 deletions
diff --git a/doc/python_api/rst/bge.render.rst b/doc/python_api/rst/bge.render.rst
index 3abbd50a453..09d16f4b2ed 100644
--- a/doc/python_api/rst/bge.render.rst
+++ b/doc/python_api/rst/bge.render.rst
@@ -87,6 +87,19 @@ Constants
Right eye being used during stereoscopic rendering.
+.. data:: KX_MIST_QUADRATIC
+
+ Type of quadratic attenuation used to fade mist.
+
+.. data:: KX_MIST_LINEAR
+
+ Type of linear attenuation used to fade mist.
+
+.. data:: KX_MIST_INV_QUADRATIC
+
+ Type of inverse quadratic attenuation used to fade mist.
+
+
*********
Functions
*********
@@ -165,20 +178,27 @@ Functions
:type rgba: list [r, g, b, a]
-.. function:: setMistColor(rgb)
+.. function:: setAmbientColor(rgb)
- Sets the mist color.
+ Sets the color of ambient light.
:type rgb: list [r, g, b]
-
-.. function:: setAmbientColor(rgb)
- Sets the color of ambient light.
+.. function:: setMistColor(rgb)
+
+ Sets the mist color.
:type rgb: list [r, g, b]
+.. function:: setMistType(mode)
+
+ Sets the mist attenuation type.
+
+ :type mode: KX_MIST_QUADRATIC, KX_MIST_LINEAR, KX_MIST_INV_QUADRATIC
+
+
.. function:: setMistStart(start)
Sets the mist start value. Objects further away than start will have mist applied to them.
@@ -193,9 +213,16 @@ Functions
:type end: float
-
+
+.. function:: setMistIntensity(intensity)
+
+ Sets the mist intensity value.
+
+ :type start: float
+
.. function:: disableMist()
+
Disables mist.
.. note:: Deprecated use setUseMist().