Differential D158 Diff 543 doc/python_api/rst/bge.render.rst

Changeset View

Standalone View

doc/python_api/rst/bge.render.rst

Context not available.

	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.

	.. data:: KX_MIST_QUADRATIC

	Type of quadratic attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_QUADRATIC)

	.. data:: KX_MIST_LINEAR

	Type of linear attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_LINEAR)

	.. data:: KX_MIST_INV_QUADRATIC

	Type of inverse quadratic attenuation used to fade mist. (Deprecated: use KX_WorldInfo.KX_MIST_INV_QUADRATIC)

	*********	*********
	Functions	Functions
	*********	*********
Context not available.

	:type rgba: list [r, g, b, a]	:type rgba: list [r, g, b, a]

	.. function:: getBackgroundColor()

	Gets the window background color. (Deprecated: use KX_WorldInfo.background_color)

	:rtype rgb: list [r, g, b]

	.. function:: setAmbientColor(rgb)	.. function:: setAmbientColor(rgb)

	Sets the color of ambient light. (Deprecated: use KX_WorldInfo.ambient_color)	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:: getAmbientColor()

	Gets the color of ambient light. (Deprecated: use KX_WorldInfo.ambient_color)

	:type rgb: list [r, g, b]

	.. function:: setMistColor(rgb)

	Sets the mist color. (Deprecated: use KX_WorldInfo.mist_color)

	:type rgb: list [r, g, b]

	.. function:: getMistColor()

	Gets the mist color. (Deprecated: use KX_WorldInfo.mist_color)

	:rtype rgb: list [r, g, b]

	.. function:: setMistType(mode)

	Sets the mist attenuation type. (Deprecated: use KX_WorldInfo.mist_type)

	:type mode: KX_MIST_QUADRATIC, KX_MIST_LINEAR, KX_MIST_INV_QUADRATIC

	.. function:: getMistType(mode)

	Gets the mist attenuation type. (Deprecated: use KX_WorldInfo.mist_type)

	:rtype: 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.
	(Deprecated: use KX_WorldInfo.mist_start)

	:type start: float

	.. function:: getMistStart()

	Gets the mist start value. (Deprecated: use KX_WorldInfo.mist_start)

	:rtype: float

	.. function:: setMistDistance(distance)

	Sets the mist distance value. Objects further away from this will be colored solid with
	the color set by setMistColor(). (Deprecated: use KX_WorldInfo.mist_distance)

	:type end: float

	:type distance: float

	Gets the mist distance value. (Deprecated: use KX_WorldInfo.mist_distance)

	:rtype: float

	.. function:: setMistIntensity(intensity)

	Sets the mist intensity value. (Deprecated: use KX_WorldInfo.mist_intensity)

	:type start: float

	.. function:: getMistIntensity()

	Gets the mist intensity value. (Deprecated: use KX_WorldInfo.mist_intensity)

	:rtype: float

	.. function:: setUseMist(enable)

	Disable or enable the mist. (Deprecated: use KX_WorldInfo.mist_enable)

	:type enable: boolean

	.. function:: mistEnabled()

	Return the state of the mist. (Deprecated: use KX_WorldInfo.mist_enable)

	:rtype: bool


	.. 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.
Context not available.