diff options
author | Benoit Bolsee <benoit.bolsee@online.be> | 2015-10-08 23:26:23 +0300 |
---|---|---|
committer | Benoit Bolsee <benoit.bolsee@online.be> | 2015-10-08 23:26:23 +0300 |
commit | c6248cce7386678ef2dc8bce3af3c5ce583fafe0 (patch) | |
tree | b47687ee7628aca16d263718086ca9098dd6df29 /doc/python_api | |
parent | 622cbd9d7f870b3f6d6b56be741a2a3f688f2790 (diff) |
BGE: new bge.logic.setRender() to enable/disable render.
The render pass is enabled by default but it can be disabled with
bge.logic.setRender(False).
Once disabled, the render pass is skipped and a new logic frame starts
immediately. Note that VSync no longer limits the fps when render is off
but the 'Use Frame Rate' option in the Render Properties still limits it.
Diffstat (limited to 'doc/python_api')
-rw-r--r-- | doc/python_api/rst/bge.logic.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.logic.rst b/doc/python_api/rst/bge.logic.rst index b119bdd1ba1..c197b77ff5f 100644 --- a/doc/python_api/rst/bge.logic.rst +++ b/doc/python_api/rst/bge.logic.rst @@ -378,6 +378,27 @@ General functions Render next frame (if Python has control) +.. function:: setRender(render) + + Sets the global flag that controls the render of the scene. + If True, the render is done after the logic frame. + If False, the render is skipped and another logic frame starts immediately. + + .. note:: + GPU VSync no longer limits the number of frame per second when render is off, + but the 'Use Frame Rate' option still regulates the fps. To run as many frames + as possible, untick this option (Render Properties, System panel) + + :arg render: the render flag + :type render: bool + +.. function:: getRender() + + Get the current value of the global render flag + + :return: The flag value + :rtype: bool + ***************** Utility functions ***************** |