From 2c2f075929169d3b5cdc7f59e2314e35b5883681 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Thu, 3 Sep 2015 15:05:36 +0200 Subject: 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. --- doc/python_api/rst/bge.render.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) 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() -- cgit v1.2.3