Blender Git Commit Log

Git Commits -> Revision 6ed1a1a

Revision 6ed1a1a by Quentin Wenger (master)
July 6, 2015, 19:48 (GMT)
BGE: bge.texture API documentation enhancement

This patch attempts to improve and review the documentation of bge.texture, as requested in the [[ | TODO list ]].

More specifically, it

- fixes the rst syntax, including titles of the examples and;

- 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).


- 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:

Commit Details:

Full Hash: 6ed1a1abe23fcff887ab0da070ee44d9e16b385e
Parent Commit: 791b5fe
Committed By: Porteries Tristan
Lines Changed: +908, -217

4 Modified Paths:

/doc/python_api/examples/ (+2, -2) (Diff)
/doc/python_api/examples/ (+2, -1) (Diff)
/doc/python_api/rst/bge.texture.rst (+868, -213) (Diff)
/source/gameengine/VideoTexture/blendVideoTex.cpp (+36, -1) (Diff)
By: Miika HämäläinenLast update: Nov-07-2014 14:18MiikaHweb | 2003-2021