blender/doc/python_api/examples
Benoit Bolsee eea89417f4 BGE: DeckLink card support for video capture and streaming.
You can capture and stream video in the BGE using the DeckLink video
   cards from Black Magic Design. You need a card and Desktop Video software
   version 10.4 or above to use these features in the BGE.
   Many thanks to Nuno Estanquiero who tested the patch extensively
   on a variety of Decklink products, it wouldn't have been possible without
   his help.
   You can find a brief summary of the decklink features here: https://wiki.blender.org/index.php/Dev:Source/GameEngine/Decklink
   The full API details and samples are in the Python API documentation.

bge.texture.VideoDeckLink(format, capture=0):

   Use this object to capture a video stream. the format argument describes
   the video and pixel formats and the capture argument the card number.
   This object can be used as a source for bge.texture.Texture so that the frame
   is sent to the GPU, or by itself using the new refresh method to get the video
   frame in a buffer.
   The frames are usually not in RGB but in YUV format (8bit or 10bit); they
   require a shader to extract the RGB components in the GPU. Details and sample
   shaders in the documentation.
   3D video capture is supported: the frames are double height with left and right
   eyes in top-bottom order. The 'eye' uniform (see setUniformEyef) can be used to
   sample the 3D frame when the BGE is also in stereo mode. This allows to composite
   a 3D video stream with a 3D scene and render it in stereo.
   In Windows, and if you have a nVidia Quadro GPU, you can benefit of an additional
   performance boost by using 'GPUDirect': a method to send a video frame to the GPU
   without going through the OGL driver. The 'pinned memory' OGL extension is also
   supported (only on high-end AMD GPU) with the same effect.

bge.texture.DeckLink(cardIdx=0, format=""):

   Use this object to send video frame to a DeckLink card. Only the immediate mode
   is supported, the scheduled mode is not implemented.
   This object is similar to bge.texture.Texture: you need to attach a image source
   and call refresh() to compute and send the frame to the card.
   This object is best suited for video keying: a video stream (not captured) flows
   through the card and the frame you send to the card are displayed above it (the
   card does the compositing automatically based on the alpha channel).
   At the time of this commit, 3D video keying is supported in the BGE but not in the
   DeckLink card due to a color space issue.
2016-06-11 22:26:05 +02:00
..
aud.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bge.constraints.py BGE: Cleanup constraints documentation 2015-05-10 15:58:17 +02:00
bge.texture.1.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bge.texture.2.py BGE: DeckLink card support for video capture and streaming. 2016-06-11 22:26:05 +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 Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.app.translations.py Cleanup: rst style 2016-02-15 19:43:08 +11: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 Cleanup: rst style 2016-02-15 19:43:08 +11: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 Cleanup: API docs 2015-09-08 19:42:58 +10: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 Fix T48212: Typos in bpy enum props examples. 2016-04-21 12:16:32 +02:00
bpy.props.4.py pep8 compliance 2011-06-21 17:17:51 +00:00
bpy.props.5.py Fix T48212: Typos in bpy enum props examples. 2016-04-21 12:16:32 +02:00
bpy.props.py correcting typos in python api docs 2015-04-24 14:08:31 +01:00
bpy.types.AddonPreferences.1.py Cleanup: API docs 2015-09-08 19:42:58 +10: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.BlendDataLibraries.write.py Docs: example for writing blend file libraries 2016-03-04 07:56:04 +11: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 Doc fix: rather then -> rather than 2015-08-05 12:48:04 +02: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 Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Menu.2.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Menu.3.py Docs: add preset menu example 2016-01-31 18:08:01 +11:00
bpy.types.Menu.py Cleanup: rst style 2016-02-15 19:43:08 +11:00
bpy.types.Mesh.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.NodeTree.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Object.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.1.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.2.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.3.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.4.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.5.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Operator.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Panel.1.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.Panel.2.py cleanup: pep8 2015-01-29 15:35:06 +11:00
bpy.types.Panel.py Cleanup: API docs 2015-09-08 19:42:58 +10:00
bpy.types.PropertyGroup.py correct example 2011-02-22 04:42:21 +00:00
bpy.types.RenderEngine.py Fix RenderEngine API docs 2016-02-08 20:35:32 +11: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 Cleanup: API docs 2015-09-08 19:42:58 +10: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
gpu.offscreen.1.py Cleanup: pep8 2016-02-01 00:47:10 +11: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