diff options
author | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-09-03 16:05:36 +0300 |
---|---|---|
committer | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-09-03 16:05:36 +0300 |
commit | 2c2f075929169d3b5cdc7f59e2314e35b5883681 (patch) | |
tree | 807e4d989b75a162851ec1ae6b2e4c8c5f17fbc5 /doc/python_api/rst | |
parent | 73b34ad06b770f1a9b4022ab9863efa80b003ae3 (diff) |
BGE docs: resolution & fullscreen changes don't work in the embedded player
The documentation for bge.render.{setWindowSize,setFullScreen,getFullScreen}
did not mention that those functions are no-ops when using the Blender-
embedded player.
Diffstat (limited to 'doc/python_api/rst')
-rw-r--r-- | doc/python_api/rst/bge.render.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.render.rst b/doc/python_api/rst/bge.render.rst index 1748ae14fc8..f9a1f8ef3de 100644 --- a/doc/python_api/rst/bge.render.rst +++ b/doc/python_api/rst/bge.render.rst @@ -108,6 +108,9 @@ Functions Set the width and height of the window (in pixels). This also works for fullscreen applications. + .. NOTE:: + Only works in the standalone player, not the Blender-embedded player. + :type width: integer :type height: integer @@ -115,12 +118,19 @@ Functions Set whether or not the window should be fullscreen. + .. NOTE:: + Only works in the standalone player, not the Blender-embedded player. + :type enable: bool .. function:: getFullScreen() Returns whether or not the window is fullscreen. + .. NOTE:: + Only works in the standalone player, not the Blender-embedded player; + there it always returns False. + :rtype: bool .. function:: getDisplayDimensions() |