Changeset View
Changeset View
Standalone View
Standalone View
doc/python_api/rst/bge.render.rst
| Show First 20 Lines • Show All 71 Lines • ▼ Show 20 Lines | .. DATA:: VSYNC_OFF | ||||
| Disables vsync | Disables vsync | ||||
| .. DATA:: VSYNC_ON | .. DATA:: VSYNC_ON | ||||
| Enables vsync | Enables vsync | ||||
| .. DATA:: VSYNC_ADAPTIVE | .. DATA:: VSYNC_ADAPTIVE | ||||
| Enables adaptive vsync if supported. Adaptive vsync enables vsync if the framerate is above the monitors refresh rate. Otherwise, vsync is diabled if the framerate is too low. | Enables adaptive vsync if supported. Adaptive vsync enables vsync if the framerate is above the monitors refresh rate. Otherwise, vsync is diabled if the framerate is too low. | ||||
hg1: KX_Scene should be KX_WorldInfo.
| |||||
| .. data:: LEFT_EYE | .. data:: LEFT_EYE | ||||
| Left eye being used during stereoscopic rendering. | Left eye being used during stereoscopic rendering. | ||||
| .. data:: RIGHT_EYE | .. data:: RIGHT_EYE | ||||
| Right eye being used during stereoscopic rendering. | Right eye being used during stereoscopic rendering. | ||||
| .. data:: KX_MIST_QUADRATIC | .. data:: KX_MIST_QUADRATIC | ||||
| Type of quadratic attenuation used to fade mist. | Type of quadratic attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_QUADRATIC) | ||||
| .. data:: KX_MIST_LINEAR | .. data:: KX_MIST_LINEAR | ||||
| Type of linear attenuation used to fade mist. | Type of linear attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_LINEAR) | ||||
| .. data:: KX_MIST_INV_QUADRATIC | .. data:: KX_MIST_INV_QUADRATIC | ||||
| Type of inverse quadratic attenuation used to fade mist. | Type of inverse quadratic attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_INV_QUADRATIC) | ||||
| ********* | ********* | ||||
| Functions | Functions | ||||
| ********* | ********* | ||||
| .. function:: getWindowWidth() | .. function:: getWindowWidth() | ||||
| ▲ Show 20 Lines • Show All 59 Lines • ▼ Show 20 Lines | .. function:: setMousePosition(x, y) | ||||
| Sets the mouse cursor position. | Sets the mouse cursor position. | ||||
| :type x: integer | :type x: integer | ||||
| :type y: integer | :type y: integer | ||||
| .. function:: setBackgroundColor(rgba) | .. function:: setBackgroundColor(rgba) | ||||
| Sets the window background color. | Sets the window background color. (Deprecated: use KX_WorldInfo.background_color) | ||||
| :type rgba: list [r, g, b, a] | :type rgba: list [r, g, b, a] | ||||
| .. function:: setAmbientColor(rgb) | .. function:: setAmbientColor(rgb) | ||||
| Sets the color of ambient light. | Sets the color of ambient light. (Deprecated: use KX_WorldInfo.ambient_color) | ||||
| :type rgb: list [r, g, b] | :type rgb: list [r, g, b] | ||||
| .. function:: setMistColor(rgb) | .. function:: setMistColor(rgb) | ||||
| Sets the mist color. | Sets the mist color. (Deprecated: use KX_WorldInfo.mist_color) | ||||
| :type rgb: list [r, g, b] | :type rgb: list [r, g, b] | ||||
| .. function:: setMistType(mode) | .. function:: setMistType(mode) | ||||
| Sets the mist attenuation type. | Sets the mist attenuation type. (Deprecated: use KX_WorldInfo.mist_type) | ||||
| :type mode: KX_MIST_QUADRATIC, KX_MIST_LINEAR, KX_MIST_INV_QUADRATIC | :type mode: KX_MIST_QUADRATIC, KX_MIST_LINEAR, KX_MIST_INV_QUADRATIC | ||||
| .. function:: setMistStart(start) | .. function:: setMistStart(start) | ||||
| Sets the mist start value. Objects further away than start will have mist applied to them. | Sets the mist start value. Objects further away than start will have mist applied to them. | ||||
| (Deprecated: use KX_WorldInfo.mist_start) | |||||
| :type start: float | :type start: float | ||||
| .. function:: setMistEnd(end) | .. function:: setMistEnd(end) | ||||
| Sets the mist end value. Objects further away from this will be colored solid with | Sets the mist end value. Objects further away from this will be colored solid with | ||||
| the color set by setMistColor(). | the color set by setMistColor(). (Deprecated: use KX_WorldInfo.mist_distance) | ||||
| :type end: float | :type end: float | ||||
| .. function:: setMistIntensity(intensity) | .. function:: setMistIntensity(intensity) | ||||
| Sets the mist intensity value. | Sets the mist intensity value. (Deprecated: use KX_WorldInfo.mist_intensity) | ||||
| :type start: float | :type start: float | ||||
| .. function:: disableMist() | .. function:: disableMist() | ||||
| Disables mist. | Disables mist. | ||||
| .. note:: Deprecated use setUseMist(). | .. note:: Deprecated: use KX_WorldInfo.mist_enable. | ||||
| .. function:: setUseMist(enable) | .. function:: setUseMist(enable) | ||||
| Disable or enable the mist. | Disable or enable the mist. (Deprecated: use KX_WorldInfo.mist_enable) | ||||
| :type enable: boolean | :type enable: boolean | ||||
| .. function:: setEyeSeparation(eyesep) | .. function:: setEyeSeparation(eyesep) | ||||
| Sets the eye separation for stereo mode. Usually Focal Length/30 provides a confortable value. | Sets the eye separation for stereo mode. Usually Focal Length/30 provides a confortable value. | ||||
| ▲ Show 20 Lines • Show All 157 Lines • Show Last 20 Lines | |||||
KX_Scene should be KX_WorldInfo.