blender/doc/python_api
Quentin Wenger 6ed1a1abe2 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
2015-07-06 21:48:25 +02:00
..
blender-org fix [#28151] export OBJ don't save the extension 2011-08-03 05:32:07 +00:00
epy hide overly picky warnings from 'pylint' for pep8 script, indentation edits. 2011-11-19 16:17:35 +00:00
examples BGE: bge.texture API documentation enhancement 2015-07-06 21:48:25 +02:00
rst BGE: bge.texture API documentation enhancement 2015-07-06 21:48:25 +02:00
rst_from_bmesh_opdefines.py Add flag for bmesh docs 2014-09-09 22:07:31 +10:00
sphinx_changelog_gen.py cleanup: pep8 2015-01-29 15:35:06 +11:00
sphinx_doc_gen_monkeypatch.py Cleanup: pep8 2014-09-17 18:36:17 +10:00
sphinx_doc_gen.py BGE: Fix T43918: adding submodule bge.app including attribute version. 2015-06-15 21:46:56 +02:00
sphinx_doc_gen.sh API Docs: remove hardcoded self from shellscript 2014-11-26 20:24:04 +01:00