diff options
| author | Mitchell Stokes <mogurijin@gmail.com> | 2013-07-30 02:31:32 +0400 |
|---|---|---|
| committer | Mitchell Stokes <mogurijin@gmail.com> | 2013-07-30 02:31:32 +0400 |
| commit | 29f8dfd37a2fbf4190e551bef0b04ff1ae1fd7b6 (patch) | |
| tree | af50623534adee419cecbbf6e0d8dd789409d266 /doc | |
| parent | 2840edba840382f0957c4963c3613c7836ac5979 (diff) | |
BGE: Adding vsync control. Users can enable vsync, disable vsync, or use adaptive vsync via UI options in the render properties, or by using the new Python method bge.render.setVsync(). Win32 and X11 support are done via EXT_swap_control. Support for using EXT_swap_control on OS X still needs to be added to Ghost.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python_api/rst/bge.render.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.render.rst b/doc/python_api/rst/bge.render.rst index c3bcf19c01b..5a80b7fa5c1 100644 --- a/doc/python_api/rst/bge.render.rst +++ b/doc/python_api/rst/bge.render.rst @@ -62,6 +62,18 @@ Constants .. data:: KX_BLENDER_GLSL_MATERIAL Materials approximating blender materials with GLSL. + +.. DATA:: VSYNC_OFF + + Disables vsync + +.. DATA:: VSYNC_ON + + Enables vsync + +.. 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. ********* Functions @@ -289,3 +301,15 @@ Functions Disable the motion blur effect. +.. function:: setVsync(value) + + Set the vsync value + + :arg value: One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE + :type value: integer + +.. function:: getVsync() + + Get the current vsync value + + :rtype: One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE |