kannonier8/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity
e48c4d73d3
blender/doc/python_api/examples
History
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
..
aud.py Fix for [#28792] Invalid 'aud' documentation examples. 2011-10-02 18:00:06 +00:00
bge.constraints.py BGE: Cleanup constraints documentation 2015-05-10 15:58:17 +02:00
bge.texture.1.py BGE: bge.texture API documentation enhancement 2015-07-06 21:48:25 +02:00
bge.texture.py BGE: bge.texture API documentation enhancement 2015-07-06 21:48:25 +02:00
blf.py pep8 cleanup, also print message when attempting to run in animation player mode. 2011-07-29 01:24:03 +00:00
bmesh.ops.1.py add bmesh.free() to example & template 2012-12-01 07:16:08 +00:00
bpy.app.handlers.1.py cmake & pep8 tidy up, also some style edits. 2011-11-08 01:32:34 +00:00
bpy.app.handlers.py cmake & pep8 tidy up, also some style edits. 2011-11-08 01:32:34 +00:00
bpy.app.translations.py 3d text tool - 'insert lorem' was crashing, also add this to the text menu. 2013-06-27 04:18:01 +00:00
bpy.data.py optparse module is deprecated, use new argparse module in background job template. 2011-03-26 03:42:59 +00:00
bpy.ops.1.py document calling operators with undo enabled. 2012-06-28 08:17:28 +00:00
bpy.ops.2.py Cleanup: pep8 2015-05-17 17:26:01 +10:00
bpy.ops.3.py style cleanup 2012-06-19 22:17:19 +00:00
bpy.ops.py document calling operators with undo enabled. 2012-06-28 08:17:28 +00:00
bpy.props.1.py examples for bpy.props 2011-02-18 14:27:18 +00:00
bpy.props.2.py correcting typos in python api docs 2015-04-24 14:08:31 +01:00
bpy.props.3.py add NDEBUG to scons release flags + some pep8 cleanup for examples. 2011-02-25 16:19:50 +00:00
bpy.props.4.py pep8 compliance 2011-06-21 17:17:51 +00:00
bpy.props.5.py Cleanup: pep8 2014-09-17 18:36:17 +10:00
bpy.props.py correcting typos in python api docs 2015-04-24 14:08:31 +01:00
bpy.types.AddonPreferences.1.py code cleanup: use BMW_begin insode for loops body. 2013-01-14 09:53:56 +00:00
bpy.types.BlendDataLibraries.load.py picky style edits with screen/view/drawing, also remove own bad example doc. 2011-08-25 15:49:52 +00:00
bpy.types.bpy_prop_collection.foreach_get.py Cleanup: pep8 2014-09-17 18:36:17 +10:00
bpy.types.bpy_prop_collection.foreach_set.py Code cleanup: style 2014-02-13 08:52:12 +11:00
bpy.types.bpy_struct.keyframe_insert.1.py can't include titles in function examples. 2011-04-08 05:03:02 +00:00
bpy.types.bpy_struct.keyframe_insert.py can't include titles in function examples. 2011-04-08 05:03:02 +00:00
bpy.types.ID.user_clear.1.py - include enum names and descriptions in sphinx generated documentation 2011-09-15 16:15:24 +00:00
bpy.types.Menu.1.py remove *.select_inverse operators where the *.select_all operator has an invert option. 2012-01-14 06:58:03 +00:00
bpy.types.Menu.2.py correcting typos in python api docs 2015-04-24 14:08:31 +01:00
bpy.types.Menu.py correcting typos in python api docs 2015-04-24 14:08:31 +01:00
bpy.types.Mesh.py style cleanup 2012-06-25 07:24:48 +00:00
bpy.types.NodeTree.py Merge of the PyNodes branch (aka "custom nodes") into trunk. 2013-03-18 16:34:57 +00:00
bpy.types.Object.py code cleanup: includes, also correct some py example typos 2012-06-16 20:20:07 +00:00
bpy.types.Operator.1.py spelling corrections. 2011-04-29 04:43:36 +00:00
bpy.types.Operator.2.py add sphinx api reference note that menu's layout.operator_context defaults to EXEC_REGION_WIN rather then INVOKE_DEFAULT. 2011-03-17 22:49:46 +00:00
bpy.types.Operator.3.py examples for bpy.props 2011-02-18 14:27:18 +00:00
bpy.types.Operator.4.py * Fix small bug in Python operator example; improved example of modal operator 2012-10-12 18:19:39 +00:00
bpy.types.Operator.5.py Cleanup: use static sets where possible 2014-09-18 17:45:31 +10:00
bpy.types.Operator.py fix for misc py errors + some pep8 edits. 2011-09-08 05:42:44 +00:00
bpy.types.Panel.1.py code cleanup: includes, also correct some py example typos 2012-06-16 20:20:07 +00:00
bpy.types.Panel.2.py cleanup: pep8 2015-01-29 15:35:06 +11:00
bpy.types.Panel.py SVN maintenance. 2011-02-18 19:33:19 +00:00
bpy.types.PropertyGroup.py correct example 2011-02-22 04:42:21 +00:00
bpy.types.RenderEngine.py fix for example 2011-07-07 21:14:36 +00:00
bpy.types.UIList.1.py Add ctrl-click rename to most lists in Blender UI and templates/examples. 2013-11-23 20:54:32 +01:00
bpy.types.UIList.2.py Add ctrl-click rename to most lists in Blender UI and templates/examples. 2013-11-23 20:54:32 +01:00
bpy.types.WindowManager.popup_menu.py sphinx docgen wasn't including example scripts for python methods of RNA types. 2013-10-15 05:55:51 +00:00
mathutils.Color.py docs / clenup (no functional code changes) 2011-10-17 02:20:53 +00:00
mathutils.Euler.py Fix example 2014-06-25 03:04:53 +10:00
mathutils.kdtree.py Code cleanup: style 2014-02-13 08:52:12 +11:00
mathutils.Matrix.py docs / clenup (no functional code changes) 2011-10-17 02:20:53 +00:00
mathutils.py [#26768] 2.57 - sys.path not initialized properly 2011-04-04 05:47:04 +00:00
mathutils.Quaternion.py mathutils: added exponential map to Quaternion 2015-02-01 13:06:00 +01:00
mathutils.Vector.py Typo fix + clarification in mathutils.Vector example 2015-02-10 21:25:01 +01:00