blender/source/gameengine
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
..
BlenderRoutines BGE: New API method getDisplayDimensions 2015-04-07 18:32:25 +02:00
Converter BGE: Fix T45267 Lib load without material caching. 2015-07-02 12:27:14 +02:00
Expressions BGE: dissallow calling reverse on internal clists 2015-06-20 20:02:16 +10:00
GameLogic BGE Cleanup: Identical code for both if/else branches 2015-05-30 18:15:11 +02:00
GamePlayer BGE : Fix black material on meshes without materials in blenderplayer. 2015-05-24 11:46:57 +02:00
Ketsji BGE: Fix T45341: Crash when camera is eliminated 2015-07-06 15:40:50 +02:00
Network mathutils: refactor instantiation 2015-01-04 17:43:57 +11:00
Physics BGE: Fix T45259 collision sensor registration. 2015-07-03 23:48:26 +02:00
Rasterizer BGE: Add integer uniforms for 2D Filter 2015-07-03 17:07:31 +02:00
SceneGraph Style Cleanup: remove preprocessor indentation (updated wiki style guide too) 2013-12-22 14:12:19 +11:00
VideoTexture BGE: bge.texture API documentation enhancement 2015-07-06 21:48:25 +02:00
CMakeLists.txt CMake: Enable strict flags for C++ 2015-03-27 18:23:31 +05:00
SConscript BGE: Removing the source files for the PHY interfaces since they just contained virtual destructors. This means we had license and doc blocks for 3 lines of code, which seemed silly. This also means that ge_phys_common no longer needs to be built as a library. I tested this with CMake and SCons using GCC; hopefully this doesn't break other systems. 2013-02-24 07:09:39 +00:00