moving bge.texture example to an external file
authorDalai Felinto <dfelinto@gmail.com>
Wed, 6 Jul 2011 07:15:56 +0000 (07:15 +0000)
committerDalai Felinto <dfelinto@gmail.com>
Wed, 6 Jul 2011 07:15:56 +0000 (07:15 +0000)
doc/python_api/examples/bge.texture.py [new file with mode: 0644]
doc/python_api/rst/bge.texture.rst

diff --git a/doc/python_api/examples/bge.texture.py b/doc/python_api/examples/bge.texture.py
new file mode 100644 (file)
index 0000000..b27c357
--- /dev/null
@@ -0,0 +1,32 @@
+"""
+Basic Video Playback
+++++++++++++++++++++++
+Example of how to replace a texture in game with a video. It needs to run everyframe
+"""
+import bge
+from bge import texture
+from bge import logic
+
+cont = logic.getCurrentController()
+obj = cont.owner
+       
+# the creation of the texture must be done once: save the 
+# texture object in an attribute of bge.logic module makes it persistent
+if not hasattr(logic, 'video'):
+       
+    # identify a static texture by name
+    matID = texture.materialID(obj, 'IMvideo.png')
+               
+    # create a dynamic texture that will replace the static texture
+    logic.video = texture.Texture(obj, matID)
+
+    # define a source of image for the texture, here a movie
+    movie = logic.expandPath('//trailer_400p.ogg')
+    logic.video.source = texture.VideoFFmpeg(movie)
+    logic.video.source.scale = True
+               
+    # quick off the movie, but it wont play in the background
+    logic.video.source.play()
+
+# you need to call this function every frame to ensure update of the texture.
+logic.video.refresh(True)
\ No newline at end of file
index b1ded95fc8974a4dbf2e4718cc80565d5b8c6e6a..49016d1e03d8f66f2ea6becfc1449d3057ff4b60 100644 (file)
@@ -1,6 +1,7 @@
 
 Game Engine bge.texture Module
 ==============================
+
 .. note::
        This documentation is still very weak, and needs some help! Right now they are mostly a collection
        of the docstrings found in the bge.texture source code + some random places filled with text.
@@ -38,36 +39,6 @@ except that you are now in control of the texture.
 When the texture object is deleted, the new texture is deleted and the old texture restored.
 
 .. module:: bge.texture
-       
-.. code-block:: python
-
-    import bge
-       from bge import texture
-    from bge import logic
-
-    cont = logic.getCurrentController()
-    obj = cont.owner
-       
-    # the creation of the texture must be done once: save the 
-    # texture object in an attribute of GameLogic module makes it persistent
-    if not hasattr(logic, 'video'):
-       
-        # identify a static texture by name
-        matID = texture.materialID(obj, 'IMvideo.png')
-               
-        # create a dynamic texture that will replace the static texture
-        logic.video = texture.Texture(obj, matID)
-               
-        # define a source of image for the texture, here a movie
-        movie = logic.expandPath('//trailer_400p.ogg')
-        logic.video.source = texture.VideoFFmpeg(movie)
-        logic.video.source.scale = True
-               
-        # quick off the movie, but it wont play in the background
-        logic.video.source.play()      
-               
-        # you need to call this function every frame to ensure update of the texture.
-        logic.video.refresh(True)
 
 .. class:: VideoFFmpeg(file [, capture=-1, rate=25.0, width=0, height=0])