Revision: 38202
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=38202
Author: campbellbarton
Date: 2011-07-07 19:23:51 +0000 (Thu, 07 Jul 2011)
Log Message:
-----------
some corrections to bge.texture docs
Modified Paths:
--------------
trunk/blender/doc/python_api/rst/bge.texture.rst
trunk/blender/doc/python_api/sphinx_doc_gen.py
Modified: trunk/blender/doc/python_api/rst/bge.texture.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.texture.rst 2011-07-07 19:10:57 UTC
(rev 38201)
+++ trunk/blender/doc/python_api/rst/bge.texture.rst 2011-07-07 19:23:51 UTC
(rev 38202)
@@ -3,8 +3,8 @@
==============================
.. 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.
+ 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.
*****
Intro
@@ -20,14 +20,14 @@
bge.texture uses FFmpeg to load images and videos. All the formats and codecs
that FFmpeg supports are supported by this module, including but not limited
to::
- * AVI
- * Ogg
- * Xvid
- * Theora
- * dv1394 camera
- * video4linux capture card (this includes many webcams)
- * videoForWindows capture card (this includes many webcams)
- * JPG
+* AVI
+* Ogg
+* Xvid
+* Theora
+* dv1394 camera
+* video4linux capture card (this includes many webcams)
+* videoForWindows capture card (this includes many webcams)
+* JPG
The principle is simple: first you identify a texture on an existing object
using
the :materialID: function, then you create a new texture with dynamic content
@@ -42,410 +42,410 @@
.. class:: VideoFFmpeg(file [, capture=-1, rate=25.0, width=0, height=0])
- FFmpeg video source
+ FFmpeg video source
- .. attribute:: status
- video status
-
- .. attribute:: range
- replay range
-
- .. attribute:: repeat
- repeat count, -1 for infinite repeat
-
- :type: int
-
- .. attribute:: framerate
- frame rate
-
- :type: float
-
- .. attribute:: valid
- Tells if an image is available
-
- :type: bool
-
- .. attribute:: image
- image data
-
- .. attribute:: size
- image size
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: preseek
- number of frames of preseek
-
- :type: int
-
- .. attribute:: deinterlace
- deinterlace image
-
- :type: bool
+ .. attribute:: status
+ video status
+
+ .. attribute:: range
+ replay range
+
+ .. attribute:: repeat
+ repeat count, -1 for infinite repeat
+
+ :type: int
- .. method:: play()
- Play (restart) video
-
- .. method:: pause()
- pause video
-
- .. method:: stop()
- stop video (play will replay it from start)
-
- .. method:: refresh()
- Refresh video - get its status
+ .. attribute:: framerate
+ frame rate
+
+ :type: float
+
+ .. attribute:: valid
+ Tells if an image is available
+
+ :type: bool
+
+ .. attribute:: image
+ image data
+
+ .. attribute:: size
+ image size
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. attribute:: filter
+ pixel filter
+
+ .. attribute:: preseek
+ number of frames of preseek
+
+ :type: int
+
+ .. attribute:: deinterlace
+ deinterlace image
+
+ :type: bool
+
+ .. method:: play()
+ Play (restart) video
+
+ .. method:: pause()
+ pause video
+
+ .. method:: stop()
+ stop video (play will replay it from start)
+
+ .. method:: refresh()
+ Refresh video - get its status
.. class:: ImageFFmpeg(file)
- FFmpeg image source
-
- .. attribute:: status
- video status
-
- .. attribute:: valid
- Tells if an image is available
-
- :type: bool
-
- .. attribute:: image
- image data
-
- .. attribute:: size
- image size
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: filter
- pixel filter
-
- .. method:: refresh()
- Refresh image, i.e. load it
-
- .. method:: reload([newname])
- Reload image, i.e. reopen it
-
+ FFmpeg image source
+
+ .. attribute:: status
+ video status
+
+ .. attribute:: valid
+ Tells if an image is available
+
+ :type: bool
+
+ .. attribute:: image
+ image data
+
+ .. attribute:: size
+ image size
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. attribute:: filter
+ pixel filter
+
+ .. method:: refresh()
+ Refresh image, i.e. load it
+
+ .. method:: reload([newname])
+ Reload image, i.e. reopen it
+
.. class:: ImageBuff()
-
- Image source from image buffer
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: image
- image data
-
- .. method:: load(imageBuffer, width, height)
- Load image from buffer
-
- .. method:: plot(imageBuffer, width, height, positionX, positionY)
- update image buffer
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: size
- image size
-
- .. attribute:: valid
- bool to tell if an image is available
+
+ Image source from image buffer
+
+ .. attribute:: filter
+ pixel filter
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. attribute:: image
+ image data
+
+ .. method:: load(imageBuffer, width, height)
+ Load image from buffer
+
+ .. method:: plot(imageBuffer, width, height, positionX, positionY)
+ update image buffer
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. attribute:: size
+ image size
+
+ .. attribute:: valid
+ bool to tell if an image is available
.. class:: ImageMirror(scene)
-
- Image source from mirror
-
- .. attribute:: alpha
- use alpha in texture
-
- .. attribute:: background
- background color
-
- .. attribute:: capsize
- size of render area
-
- .. attribute:: clip
- clipping distance
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: image
- image data
-
- .. method:: refresh(imageMirror)
- Refresh image - invalidate its current content
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: size
- image size
-
- .. attribute:: valid
- bool to tell if an image is available
-
- .. attribute:: whole
- use whole viewport to render
+
+ Image source from mirror
+
+ .. attribute:: alpha
+ use alpha in texture
+
+ .. attribute:: background
+ background color
+
+ .. attribute:: capsize
+ size of render area
+
+ .. attribute:: clip
+ clipping distance
+
+ .. attribute:: filter
+ pixel filter
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. attribute:: image
+ image data
+
+ .. method:: refresh(imageMirror)
+ Refresh image - invalidate its current content
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. attribute:: size
+ image size
+
+ .. attribute:: valid
+ bool to tell if an image is available
+
+ .. attribute:: whole
+ use whole viewport to render
.. class:: ImageMix()
-
- Image mixer
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: flip
- flip image vertically
-
- .. method:: getSource(imageMix)
- get image source
-
- .. method:: getWeight(imageMix)
- get image source weight
-
- .. attribute:: image
- image data
-
- .. method:: refresh(imageMix)
- Refresh image - invalidate its current content
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. method:: setSource(imageMix)
- set image source
-
- .. method:: setWeight(imageMix)
- set image source weight
-
- .. attribute:: valid
- bool to tell if an image is available
+
+ Image mixer
+
+ .. attribute:: filter
+ pixel filter
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. method:: getSource(imageMix)
+ get image source
+
+ .. method:: getWeight(imageMix)
+ get image source weight
+
+ .. attribute:: image
+ image data
+
+ .. method:: refresh(imageMix)
+ Refresh image - invalidate its current content
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. method:: setSource(imageMix)
+ set image source
+
+ .. method:: setWeight(imageMix)
+ set image source weight
+
+ .. attribute:: valid
+ bool to tell if an image is available
.. class:: ImageRender(scene, camera)
-
- Image source from render
-
- .. attribute:: alpha
- use alpha in texture
-
- .. attribute:: background
- background color
-
- .. attribute:: capsize
- size of render area
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: image
- image data
-
- .. method:: refresh(imageRender)
- Refresh image - invalidate its current content
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: size
- image size
-
- .. attribute:: valid
- bool to tell if an image is available
-
- .. attribute:: whole
- use whole viewport to render
+
+ Image source from render
+
+ .. attribute:: alpha
+ use alpha in texture
+
+ .. attribute:: background
+ background color
+
+ .. attribute:: capsize
+ size of render area
+
+ .. attribute:: filter
+ pixel filter
+
+ .. attribute:: flip
+ flip image vertically
+
+ .. attribute:: image
+ image data
+
+ .. method:: refresh(imageRender)
+ Refresh image - invalidate its current content
+
+ .. attribute:: scale
+ fast scale of image (near neighbour)
+
+ .. attribute:: size
+ image size
+
+ .. attribute:: valid
+ bool to tell if an image is available
+
+ .. attribute:: whole
+ use whole viewport to render
.. class:: ImageViewport()
-
- Image source from viewport
-
- .. attribute:: alpha
- use alpha in texture
-
- .. attribute:: capsize
- size of viewport area being captured
-
- .. attribute:: filter
- pixel filter
-
- .. attribute:: flip
- flip image vertically
-
- .. attribute:: image
- image data
-
- .. attribute:: position
- upper left corner of captured area
-
- .. method:: refresh(imageViewport)
- Refresh image - invalidate its current content
-
- .. attribute:: scale
- fast scale of image (near neighbour)
-
- .. attribute:: size
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
