diff options
author | Quentin Wenger <matpi@protonmail.ch> | 2015-07-06 12:11:40 +0300 |
---|---|---|
committer | Porteries Tristan <republicthunderbolt9@gmail.com> | 2015-07-06 22:48:25 +0300 |
commit | 6ed1a1abe23fcff887ab0da070ee44d9e16b385e (patch) | |
tree | 26965cc4eb9c4113d37d0beddb45281bbe65fc30 /doc/python_api/examples/bge.texture.py | |
parent | 791b5fe9d0c47460700b5725faff687f892f06cf (diff) |
BGE: bge.texture API documentation enhancement
This patch attempts to improve and review the documentation of bge.texture, as requested in the [[ http://wiki.blender.org/index.php/Dev:2.5/Source/Development/Todo/GameEngine#Video_Texture | TODO list ]].
More specifically, it
- fixes the rst syntax, including titles of the examples bge.texture.py and bge.texture.1.py;
- adds, standardizes and reviews description of the API elements, particularly signatures, types, etc.
- adds SOURCE_* constants to the doc
- splits the doc into thematical parts (Video, Image, Texture, and Filter Classes, Functions, Constants).
Notes:
- The parameter "mode" of ImageBuff.plot has to be described better. Actually, the whole set of IMB_BLEND_* constants (from IMB_imbuf.h) should be exposed to Python. I'll do that in a future diff, and complete the doc at the same moment (adding those IMB_BLEND_* constants to the Constants part of this doc).
- The option of using webcams in VideoFFmpeg is still particularly not well documented. I am planning to make a proposal about fixing T18634 (and its corresponding TODO in the list) by integrating OpenCV in the BGE (and Blender?). The idea would then probably be to add a new class, f.ex. ImageWebcam, making this functionnality more specialized. So for now I don't think it is worth to document that part much.
This patch fixes T44284 too.
Reviewers: moguri, kupoman, campbellbarton, panzergame, lordloki
Reviewed By: panzergame, lordloki
Subscribers: hg1
Projects: #game_engine, #game_python, #documentation
Maniphest Tasks: T44284
Differential Revision: https://developer.blender.org/D1352
Diffstat (limited to 'doc/python_api/examples/bge.texture.py')
-rw-r--r-- | doc/python_api/examples/bge.texture.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/python_api/examples/bge.texture.py b/doc/python_api/examples/bge.texture.py index 1ba0b99fc27..ac1f5a21447 100644 --- a/doc/python_api/examples/bge.texture.py +++ b/doc/python_api/examples/bge.texture.py @@ -1,7 +1,8 @@ """ Basic Video Playback ++++++++++++++++++++ -Example of how to replace a texture in game with a video. It needs to run everyframe +Example of how to replace a texture in game with a video. It needs to run +everyframe. """ import bge from bge import texture |