Page MenuHome
Differential D1352 Diff 4428 doc/python_api/rst/bge.texture.rst

Changeset View

Standalone View

View Options

doc/python_api/rst/bge.texture.rst

Video Texture (bge.texture) Video Texture (bge.texture)
=========================== ===========================
***** ************
Intro Introduction
***** ************
The bge.texture module allows you to manipulate textures during the game. The bge.texture module allows you to manipulate textures during the game.
Several sources for texture are possible: video files, image files, video capture, memory buffer, camera render or a mix of that. Several sources for texture are possible: video files, image files, video capture, memory buffer, camera render or a mix of that.
The video and image files can be loaded from the internet using an URL instead of a file name. The video and image files can be loaded from the internet using an URL instead of a file name.
In addition, you can apply filters on the images before sending them to the GPU, allowing video effect: blue screen, color band, gray, normal map. In addition, you can apply filters on the images before sending them to the GPU, allowing video effect: blue screen, color band, gray, normal map.
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:: 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 * AVI
* Ogg * Ogg
* Xvid * Xvid
* Theora * Theora
* dv1394 camera * dv1394 camera
* video4linux capture card (this includes many webcams) * video4linux capture card (this includes many webcams)
* videoForWindows capture card (this includes many webcams) * videoForWindows capture card (this includes many webcams)
* JPG * JPG
The principle is simple: first you identify a texture on an existing object using 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 the :class:`~bge.texture.materialID` function, then you create a new texture with dynamic content
and swap the two textures in the GPU. and swap the two textures in the GPU.
The GE is not aware of the substitution and continues to display the object as always, The GE is not aware of the substitution and continues to display the object as always,
except that you are now in control of the texture. 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. When the texture object is deleted, the new texture is deleted and the old texture restored.
.. module:: bge.texture .. module:: bge.texture
.. literalinclude:: ../examples/bge.texture.py .. include:: ../examples/bge.texture.py
:language: rest :start-line: 1
:lines: 2-4 :end-line: 5
.. literalinclude:: ../examples/bge.texture.py .. literalinclude:: ../examples/bge.texture.py
:lines: 6- :lines: 7-
.. literalinclude:: ../examples/bge.texture.1.py .. include:: ../examples/bge.texture.1.py
:language: rest :start-line: 1
:lines: 2-6 :end-line: 6
.. literalinclude:: ../examples/bge.texture.1.py .. literalinclude:: ../examples/bge.texture.1.py
:lines: 8- :lines: 8-
.. class:: VideoFFmpeg(file [, capture=-1, rate=25.0, width=0, height=0])
FFmpeg video source *************
Video classes
*************
.. class:: VideoFFmpeg(file, capture=-1, rate=25.0, width=0, height=0)
FFmpeg video source.
:arg file: Path to the video to load; if capture >= 0 on Windows, this parameter will not be used.
:type file: str
:arg capture: Capture device number; if >= 0, the corresponding webcam will be used. (optional)
:type capture: int
:arg rate: Capture rate. (optional, used only if capture >= 0)
:type rate: float
:arg width: Capture width. (optional, used only if capture >= 0)
:type width: int
:arg height: Capture height. (optional, used only if capture >= 0)
:type height: int
.. attribute:: status .. attribute:: status
video status Video status. (readonly)
:type: int
:value: one of...
* :data:`SOURCE_ERROR`
* :data:`SOURCE_EMPTY`
* :data:`SOURCE_READY`
* :data:`SOURCE_PLAYING`
* :data:`SOURCE_STOPPED`
.. attribute:: range .. attribute:: range
replay range Replay range.
:type: sequence of two floats
.. attribute:: repeat .. attribute:: repeat
repeat count, -1 for infinite repeat Repeat count, -1 for infinite repeat.
:type: int :type: int
.. attribute:: framerate .. attribute:: framerate
frame rate Frame rate.
:type: float :type: float
.. attribute:: valid .. attribute:: valid
Tells if an image is available Tells if an image is available. (readonly)
:type: bool :type: bool
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
:type: :class:`~bgl.Buffer` or None
.. attribute:: size .. attribute:: size
image size Image size. (readonly)
:type: tuple of two ints
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: preseek .. attribute:: preseek
number of frames of preseek Number of frames of preseek.
:type: int :type: int
.. attribute:: deinterlace .. attribute:: deinterlace
deinterlace image Deinterlace image.
:type: bool :type: bool
.. method:: play() .. method:: play()
Play (restart) video Play (restart) video.
:return: Whether the video was ready or stopped.
:rtype: bool
.. method:: pause() .. method:: pause()
pause video Pause video.
:return: Whether the video was playing.
:rtype: bool
.. method:: stop() .. method:: stop()
stop video (play will replay it from start) Stop video (play will replay it from start).
:return: Whether the video was playing.
:rtype: bool
.. method:: refresh() .. method:: refresh()
Refresh video - get its status Refresh video - get its status.
:return: The video's status, one of...
* :data:`SOURCE_ERROR`
* :data:`SOURCE_EMPTY`
* :data:`SOURCE_READY`
* :data:`SOURCE_PLAYING`
* :data:`SOURCE_STOPPED`
:rtype: int
*************
Image classes
*************
.. class:: ImageFFmpeg(file) .. class:: ImageFFmpeg(file)
FFmpeg image source FFmpeg image source.
:arg file: Path to the image to load.
:type file: str
.. attribute:: status .. attribute:: status
video status Image status. (readonly)
:type: int
:value: one of...
* :data:`SOURCE_ERROR`
* :data:`SOURCE_EMPTY`
* :data:`SOURCE_READY`
* :data:`SOURCE_PLAYING`
* :data:`SOURCE_STOPPED`
.. attribute:: valid .. attribute:: valid
Tells if an image is available Tells if an image is available. (readonly)
:type: bool :type: bool
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
:type: :class:`~bgl.Buffer` or None
.. attribute:: size .. attribute:: size
image size Image size. (readonly)
:type: tuple of two ints
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. method:: refresh() .. method:: refresh()
Refresh image, i.e. load it Refresh image, i.e. load it.
:return: the video's status, one of...
.. method:: reload([newname]) * :data:`SOURCE_ERROR`
* :data:`SOURCE_EMPTY`
* :data:`SOURCE_READY`
* :data:`SOURCE_PLAYING`
* :data:`SOURCE_STOPPED`
Reload image, i.e. reopen it :rtype: int
.. class:: ImageBuff() .. method:: reload(newname=None)
Image source from image buffer Reload image, i.e. reopen it.
hg1Unsubmitted
Not Done
Inline Actions

That is wrong. The value is a python integer converted to an unsigned char 0-255 (black to white).

hg1: That is wrong. The value is a python integer converted to an unsigned char 0-255 (black to…
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Whoops, yes, you're right, I mixed up "b" parsing arguments with bools...

Matpi: Whoops, yes, you're right, I mixed up "b" parsing arguments with bools...
:arg newname: Path to a new image. (optional)
:type newname: str
.. class:: ImageBuff(width, height, color=0, scale=False)
Image source from image buffer.
:arg width: Width of the image.
:type width: int
:arg height: Height of the image.
:type height: int
:arg color: Value to initialize RGB channels with. The initialized buffer will have
all pixels set to (color, color, color, 255). (optional)
:type color: int in [0, 255]
:arg scale: Image uses scaling. (optional)
:type scale: bool
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: image .. attribute:: image
hg1Unsubmitted
Not Done
Inline Actions

positionY [, mode=IMB_BLEND_COPY]) or positionY, [mode=IMB_BLEND_COPY]) will look better.

hg1: positionY [, mode=IMB_BLEND_COPY]) or positionY, [mode=IMB_BLEND_COPY]) will look better.
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Don't agree here: this is the standard way to do it, look for example at os.getenv (took python 2.7 API because it uses nearly the same theme as Blender API doc).

Matpi: Don't agree here: this is the standard way to do it, look for example at [[ https://docs.python.
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Ok, changed it to key=default_value to reflect Blender's standard.

Matpi: Ok, changed it to key=default_value to reflect Blender's standard.
hg1Unsubmitted
Not Done
Inline Actions

Yes I know, but for me it looks ugly. Maybe it is better to remove the square bracket. I looked into the Blender API and I don't find any methods which are using square bracket for optional arguments.
I think it is better to ask Campbell.

hg1: Yes I know, but for me it looks ugly. Maybe it is better to remove the square bracket. I looked…
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Sorry, I answered but forgot to submit my answer... :-/

I actually discussed with Campbell, and he told me that in Blender the "defaults" solution is in use rather than the "square brackets" one. My last diff shows that change.

Sorry again for the inconvenience.

Matpi: Sorry, I answered but forgot to submit my answer... :-/ I actually discussed with Campbell…
image data Image data. (readonly)
:type: :class:`~bgl.Buffer` or None
.. method:: load(imageBuffer, width, height) .. method:: load(imageBuffer, width, height)
Load image from buffer Load image from buffer.
.. method:: plot(imageBuffer, width, height, positionX, positionY) :arg imageBuffer: Buffer to load the image from.
:type imageBuffer: :class:`~bgl.Buffer` or Python object implementing the buffer protocol (f.ex. bytes)
:arg width: Width of the image to load.
:type width: int
:arg height: Height of the image to load.
:type height: int
.. method:: plot(imageBuffer, width, height, positionX, positionY, mode=IMB_BLEND_COPY)
Update image buffer.
:arg imageBuffer: Buffer to load the new data from.
:type imageBuffer: :class:`~bgl.Buffer`, :class:`ImageBuff` or Python object implementing the buffer protocol (f.ex. bytes)
:arg width: Width of the data to load.
:type width: int
:arg height: Height of the data to load.
:type height: int
:arg positionX: Left boundary of the region to be drawn on.
:type positionX: int
:arg positionY: Upper boundary of the region to be drawn on.
:type positionY: int
:arg mode: Drawing mode, one of... (optional)
* :data:`IMB_BLEND_MIX`
* :data:`IMB_BLEND_ADD`
* :data:`IMB_BLEND_SUB`
* :data:`IMB_BLEND_MUL`
* :data:`IMB_BLEND_LIGHTEN`
* :data:`IMB_BLEND_DARKEN`
* :data:`IMB_BLEND_ERASE_ALPHA`
* :data:`IMB_BLEND_ADD_ALPHA`
hg1Unsubmitted
Not Done
Inline Actions

I hope you know, if you don't make a list, sphinx will align vertical text still horizontal.

The output will look like this.

mode (int) – Drawing mode (IMB_BLEND_MIX, IMB_BLEND_ADD, IMB_BLEND_SUB, IMB_BLEND_MUL, IMB_BLEND_LIGHTEN, IMB_BLEND_DARKEN, IMB_BLEND_ERASE_ALPHA, IMB_BLEND_ADD_ALPHA, IMB_BLEND_OVERLAY, IMB_BLEND_HARDLIGHT, IMB_BLEND_COLORBURN, IMB_BLEND_LINEARBURN, IMB_BLEND_COLORDODGE, IMB_BLEND_SCREEN, IMB_BLEND_SOFTLIGHT, IMB_BLEND_PINLIGHT, IMB_BLEND_VIVIDLIGHT, IMB_BLEND_LINEARLIGHT, IMB_BLEND_DIFFERENCE, IMB_BLEND_EXCLUSION, IMB_BLEND_HUE, IMB_BLEND_SATURATION, IMB_BLEND_LUMINOSITY, IMB_BLEND_COLOR, IMB_BLEND_COPY, IMB_BLEND_COPY_RGB, IMB_BLEND_COPY_ALPHA). (optional)

hg1: I hope you know, if you don't make a list, sphinx will align vertical text still horizontal.
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Yes, I know, but lists aren't supported into arguments AFAIK (look at the compiled doc for 2.74 -> nothing shown). The only way I found was to make a simple list, even if horizontal. But I'd be very happy to find a way to make vertical lists...

Matpi: Yes, I know, but lists aren't supported into arguments AFAIK (look at the compiled doc for 2.74…
* :data:`IMB_BLEND_OVERLAY`
* :data:`IMB_BLEND_HARDLIGHT`
* :data:`IMB_BLEND_COLORBURN`
* :data:`IMB_BLEND_LINEARBURN`
* :data:`IMB_BLEND_COLORDODGE`
* :data:`IMB_BLEND_SCREEN`
* :data:`IMB_BLEND_SOFTLIGHT`
* :data:`IMB_BLEND_PINLIGHT`
* :data:`IMB_BLEND_VIVIDLIGHT`
* :data:`IMB_BLEND_LINEARLIGHT`
* :data:`IMB_BLEND_DIFFERENCE`
* :data:`IMB_BLEND_EXCLUSION`
* :data:`IMB_BLEND_HUE`
* :data:`IMB_BLEND_SATURATION`
* :data:`IMB_BLEND_LUMINOSITY`
* :data:`IMB_BLEND_COLOR`
* :data:`IMB_BLEND_COPY`
* :data:`IMB_BLEND_COPY_RGB`
* :data:`IMB_BLEND_COPY_ALPHA`
:type mode: int
update image buffer
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: size .. attribute:: size
image size Image size. (readonly)
:type: tuple of two ints
.. attribute:: valid .. attribute:: valid
bool to tell if an image is available Tells if an image is available. (readonly)
.. class:: ImageMirror(scene) :type: bool
.. class:: ImageMirror(scene, observer, mirror, material=0)
Image source from mirror Image source from mirror.
:arg scene: Scene in which the image has to be taken.
:type scene: :class:`~bge.types.KX_Scene`
:arg observer: Reference object for the mirror (the object from which the mirror has to be looked at, for example a camera).
:type observer: :class:`~bge.types.KX_GameObject`
:arg mirror: Object holding the mirror.
:type mirror: :class:`~bge.types.KX_GameObject`
:arg material: ID of the mirror's material to be used for mirroring. (optional)
:type material: int
.. attribute:: alpha .. attribute:: alpha
use alpha in texture Use alpha in texture.
:type: bool
.. attribute:: background .. attribute:: background
background color Background color.
:type: int or float list [r, g, b, a] in [0.0, 255.0] :type: int or float list [r, g, b, a] in [0.0, 255.0]
.. attribute:: capsize .. attribute:: capsize
size of render area Size of render area.
:type: sequence of two ints
.. attribute:: clip .. attribute:: clip
clipping distance Clipping distance.
:type: float in [0.01, 5000.0]
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
hg1Unsubmitted
Not Done
Inline Actions

The attribute image returns a integer list [r,g,b,a]. Range: 0 to 255.

hg1: The attribute image returns a integer list [r,g,b,a]. Range: 0 to 255.
MatpiAuthorUnsubmitted
Not Done
Inline Actions

Don't agree, look ImageBase.cpp/Image_getImage or test. Or am I completely wrong?

Matpi: Don't agree, look ImageBase.cpp/Image_getImage or test. Or am I completely wrong?
hg1Unsubmitted
Not Done
Inline Actions

Yes you are right, it now prints out Buffer(GL_BYTE, [...]). In previous it returns only a list in the printout.
Example:
Buffer(GL_BYTE, [0, 0, 255, 255, 128, 128, 255, 255, 255, 255, 255, 255, 127, 0, 127, 255, 128, 128, 127, 255, 127, 255, 127, 255, 255, 0, 0, 255, 128, 128, 0, 255, 0, 255, 0, 255])

hg1: Yes you are right, it now prints out Buffer(GL_BYTE, [...]). In previous it returns only a list…
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
.. method:: refresh(imageMirror) :type: :class:`~bgl.Buffer` or None
.. method:: refresh()
Refresh image - invalidate its current content Refresh image - invalidate its current content.
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: size .. attribute:: size
image size Image size (readonly).
:type: tuple of two ints
.. attribute:: valid .. attribute:: valid
bool to tell if an image is available Tells if an image is available. (readonly)
:type: bool
.. attribute:: whole .. attribute:: whole
use whole viewport to render Use whole viewport to render.
:type: bool
.. class:: ImageMix() .. class:: ImageMix
Image mixer Image mixer.
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. method:: getSource(id)
Get image source.
.. method:: getSource(imageMix) :arg id: Identifier of the source to get.
:type id: str
get image source :return: Image source.
:rtype: one of...
.. method:: getWeight(imageMix) * :class:`VideoFFmpeg`
* :class:`ImageFFmpeg`
* :class:`ImageBuff`
* :class:`ImageMirror`
* :class:`ImageMix`
* :class:`ImageRender`
* :class:`ImageViewport`
get image source weight .. method:: getWeight(id)
Get image source weight.
:arg id: Identifier of the source.
:type id: str
:return: Weight of the source.
:rtype: int
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
.. method:: refresh(imageMix) :type: :class:`~bgl.Buffer` or None
.. method:: refresh()
Refresh image - invalidate its current content Refresh image - invalidate its current content.
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: size
Image size. (readonly)
:type: tuple of two ints
.. method:: setSource(id, image)
Set image source - all sources must have the same size.
:arg id: Identifier of the source to set.
:type id: str
:arg image: Image source of type...
.. method:: setSource(imageMix) * :class:`VideoFFmpeg`
* :class:`ImageFFmpeg`
* :class:`ImageBuff`
* :class:`ImageMirror`
* :class:`ImageMix`
* :class:`ImageRender`
* :class:`ImageViewport`
set image source .. method:: setWeight(id, weight)
.. method:: setWeight(imageMix) Set image source weight - the sum of the weights should be 256 to get full color intensity in the output.
set image source weight :arg id: Identifier of the source.
:type id: str
:arg weight: Weight of the source.
:type weight: int
.. attribute:: valid .. attribute:: valid
bool to tell if an image is available Tells if an image is available. (readonly)
:type: bool
.. class:: ImageRender(scene, camera) .. class:: ImageRender(scene, camera)
Image source from render Image source from render.
:arg scene: Scene in which the image has to be taken.
:type scene: :class:`~bge.types.KX_Scene`
:arg camera: Camera from which the image has to be taken.
:type camera: :class:`~bge.types.KX_Camera`
.. attribute:: alpha .. attribute:: alpha
use alpha in texture Use alpha in texture.
:type: bool
.. attribute:: background .. attribute:: background
background color Background color.
:type: int or float list [r, g, b, a] in [0.0, 255.0] :type: int or float list [r, g, b, a] in [0.0, 255.0]
.. attribute:: capsize .. attribute:: capsize
size of render area Size of render area.
:type: sequence of two ints
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
:type: :class:`~bgl.Buffer` or None
.. method:: refresh(imageRender) .. method:: refresh()
Refresh image - invalidate its current content Refresh image - invalidate its current content.
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: size .. attribute:: size
image size Image size. (readonly)
:type: tuple of two ints
.. attribute:: valid .. attribute:: valid
bool to tell if an image is available Tells if an image is available. (readonly)
:type: bool
.. attribute:: whole .. attribute:: whole
use whole viewport to render Use whole viewport to render.
:type: bool
.. attribute:: depth .. attribute:: depth
use depth component of render as array of float - not suitable for texture source, Use depth component of render as array of float - not suitable for texture source,
should only be used with bge.texture.imageToArray(mode='F') should only be used with bge.texture.imageToArray(mode='F').
:type: bool
.. attribute:: zbuff .. attribute:: zbuff
use depth component of render as grey scale color - suitable for texture source Use depth component of render as grey scale color - suitable for texture source.
.. class:: ImageViewport() :type: bool
Image source from viewport .. class:: ImageViewport
Image source from viewport.
.. attribute:: alpha .. attribute:: alpha
use alpha in texture Use alpha in texture.
:type: bool
.. attribute:: capsize .. attribute:: capsize
size of viewport area being captured Size of viewport area being captured.
:type: sequence of two ints
.. attribute:: filter .. attribute:: filter
pixel filter Pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. attribute:: flip .. attribute:: flip
flip image vertically Flip image vertically.
:type: bool
.. attribute:: image .. attribute:: image
image data Image data. (readonly)
:type: :class:`~bgl.Buffer` or None
.. attribute:: position .. attribute:: position
upper left corner of captured area Upper left corner of the captured area.
:type: sequence of two ints
.. method:: refresh(imageViewport) .. method:: refresh()
Refresh image - invalidate its current content Refresh image - invalidate its current content.
.. attribute:: scale .. attribute:: scale
fast scale of image (near neighbour) Fast scale of image (near neighbour).
:type: bool
.. attribute:: size .. attribute:: size
image size Image size. (readonly)
:type: tuple of two ints
.. attribute:: valid .. attribute:: valid
bool to tell if an image is available Tells if an image is available. (readonly)
:type: bool
.. attribute:: whole .. attribute:: whole
use whole viewport to capture Use whole viewport to capture.
:type: bool
.. attribute:: depth .. attribute:: depth
use depth component of viewport as array of float - not suitable for texture source, Use depth component of viewport as array of float - not suitable for texture source,
should only be used with bge.texture.imageToArray(mode='F') should only be used with bge.texture.imageToArray(mode='F').
:type: bool
.. attribute:: zbuff .. attribute:: zbuff
use depth component of viewport as grey scale color - suitable for texture source Use depth component of viewport as grey scale color - suitable for texture source.
.. class:: Texture(gameObj) :type: bool
Texture objects
***************
Texture classes
***************
.. class:: Texture(gameObj, materialID=0, textureID=0, textureObj=None)
Texture object.
:arg gameObj: Game object to be created a video texture on.
:type gameObj: :class:`~bge.types.KX_GameObject`
:arg materialID: Material ID. (optional)
:type materialID: int
:arg textureID: Texture ID. (optional)
:type textureID: int
:arg textureObj: Texture object with shared bindId. (optional)
:type textureObj: :class:`Texture`
.. attribute:: bindId .. attribute:: bindId
OpenGL Bind Name OpenGL Bind Name. (readonly)
:type: int
.. method:: close(texture) .. method:: close()
Close dynamic texture and restore original Close dynamic texture and restore original.
.. attribute:: mipmap .. attribute:: mipmap
mipmap texture Mipmap texture.
:type: bool
.. method:: refresh(refresh_source=True, ts=-1.0)
.. method:: refresh(texture) Refresh texture from source.
Refresh texture from source :arg refresh_source: Whether to also refresh the image source of the texture.
:type refresh_source: bool
:arg ts: If the texture controls a VideoFFmpeg object:
timestamp (in seconds from the start of the movie) of the frame to be loaded; this can be
used for video-sound synchonization by passing :attr:`~bge.types.KX_SoundActuator.time` to it. (optional)
:type ts: float
.. attribute:: source .. attribute:: source
source of texture Source of texture.
:type: one of...
* :class:`VideoFFmpeg`
* :class:`ImageFFmpeg`
* :class:`ImageBuff`
* :class:`ImageMirror`
* :class:`ImageMix`
* :class:`ImageRender`
* :class:`ImageViewport`
.. class:: FilterBGR24()
Source filter BGR24 objects **************
Filter classes
**************
.. class:: FilterBlueScreen()
Filter for Blue Screen objects .. class:: FilterBGR24
Source filter BGR24.
.. class:: FilterBlueScreen
Filter for Blue Screen. The RGB channels of the color are left unchanged, while the output alpha is obtained as follows:
* if the square of the euclidian distance between the RGB color and the filter's reference color is smaller than the filter's lower limit,
the output alpha is set to 0;
* if that square is bigger than the filter's upper limit, the output alpha is set to 255;
* otherwise the output alpha is linarly extrapoled between 0 and 255 in the interval of the limits.
.. attribute:: color .. attribute:: color
blue screen color Reference color.
:type: sequence of three ints
:default: (0, 0, 255)
.. attribute:: limits .. attribute:: limits
blue screen color limits Reference color limits.
:type: sequence of two ints
:default: (64, 64)
.. attribute:: previous .. attribute:: previous
previous pixel filter Previous pixel filter.
:type: one of...
.. class:: FilterColor() * :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
Filter for color calculations .. class:: FilterColor
Filter for color calculations. The output color is obtained by multiplying the reduced 4x4 matrix with the input color
and adding the remaining column to the result.
.. attribute:: matrix .. attribute:: matrix
matrix [4][5] for color calculation Matrix [4][5] for color calculation.
:type: sequence of four sequences of five ints
:default: ((256, 0, 0, 0, 0), (0, 256, 0, 0, 0), (0, 0, 256, 0, 0), (0, 0, 0, 256, 0))
.. attribute:: previous .. attribute:: previous
previous pixel filter Previous pixel filter.
:type: one of...
.. class:: FilterGray() * :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
Filter for gray scale effect .. class:: FilterGray
Filter for gray scale effect. Proportions of R, G and B contributions in the output gray scale are 28:151:77.
.. attribute:: previous .. attribute:: previous
previous pixel filter Previous pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. class:: FilterLevel
Filter for levels calculations. Each output color component is obtained as follows:
* if it is smaller than its corresponding min value, it is set to 0;
.. class:: FilterLevel() * if it is bigger than its corresponding max value, it is set to 255;
Filter for levels calculations * Otherwise it is linearly extrapoled between 0 and 255 in the (min, max) interval.
.. attribute:: levels .. attribute:: levels
levels matrix [4] (min, max) Levels matrix [4] (min, max).
:type: sequence of four sequences of two ints
:default: ((0, 255), (0, 255), (0, 255), (0, 255))
.. attribute:: previous .. attribute:: previous
previous pixel filter Previous pixel filter.
:type: one of...
* :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
* :class:`FilterRGBA32`
.. class:: FilterNormal() .. class:: FilterNormal
Filter for Blue Screen objects Normal map filter.
.. attribute:: colorIdx .. attribute:: colorIdx
index of color used to calculate normal (0 - red, 1 - green, 2 - blue) Index of color used to calculate normal (0 - red, 1 - green, 2 - blue, 3 - alpha).
:type: int in [0, 3]
:default: 0
.. attribute:: depth .. attribute:: depth
depth of relief Depth of relief.
:type: float
:default: 4.0
.. attribute:: previous .. attribute:: previous
previous pixel filter Previous pixel filter.
:type: one of...
.. class:: FilterRGB24() * :class:`FilterBGR24`
* :class:`FilterBlueScreen`
* :class:`FilterColor`
* :class:`FilterGray`
* :class:`FilterLevel`
* :class:`FilterNormal`
* :class:`FilterRGB24`
hg1Unsubmitted
Not Done
Inline Actions

The resulting output looks really terrible (also the original). Maybe you can improve the readability with a list.

hg1: The resulting output looks really terrible (also the original). Maybe you can improve the…
MatpiAuthorUnsubmitted
Not Done
Inline Actions

As said above, lists are problematic. But you're right, this part should be made better.

Matpi: As said above, lists are problematic. But you're right, this part should be made better.
* :class:`FilterRGBA32`
.. class:: FilterRGB24
Returns a new input filter object to be used with :class:`ImageBuff` object when the image passed Returns a new input filter object to be used with :class:`ImageBuff` object when the image passed
to the ImageBuff.load() function has the 3-bytes pixel format BGR. to the :meth:`ImageBuff.load` function has the 3-bytes pixel format BGR.
.. class:: FilterRGBA32
.. class:: FilterRGBA32() Source filter RGBA32.
Source filter RGBA32 objects
*********
Functions
*********
.. function:: getLastError() .. function:: getLastError()
Last error that occurred in a bge.texture function. Last error that occurred in a bge.texture function.
:return: the description of the last error occurred in a bge.texture function. :return: The description of the last error occurred in a bge.texture function.
:rtype: string :rtype: str
.. function:: imageToArray(image,mode) .. function:: imageToArray(image, mode)
Returns a :class:`~bgl.buffer` corresponding to the current image stored in a texture source object. Returns a :class:`~bgl.Buffer` corresponding to the current image stored in a texture source object.
:arg image: Image source object of type ...
* :class:`VideoFFmpeg`
* :class:`ImageFFmpeg`
* :class:`ImageBuff`
* :class:`ImageMirror`
* :class:`ImageMix`
* :class:`ImageRender`
* :class:`ImageViewport`
:arg mode: Optional argument representing the pixel format.
:arg image: Image source object. * You can use the characters R, G, B for the 3 color channels, A for the alpha channel,
:type image: object of type :class:`VideoFFmpeg`, :class:`ImageFFmpeg`, :class:`ImageBuff`, :class:`ImageMix`, :class:`ImageRender`, :class:`ImageMirror` or :class:`ImageViewport`
:arg mode: optional argument representing the pixel format.
You can use the characters R, G, B for the 3 color channels, A for the alpha channel,
0 to force a fixed 0 color channel and 1 to force a fixed 255 color channel. 0 to force a fixed 0 color channel and 1 to force a fixed 255 color channel.
Example: "BGR" will return 3 bytes per pixel with the Blue, Green and Red channels in that order.
"RGB1" will return 4 bytes per pixel with the Red, Green, Blue channels in that order and the alpha channel forced to 255. Examples:
A special mode "F" allows to return the image as an array of float. This mode should only be used to retrieve * "BGR" will return 3 bytes per pixel with the Blue, Green and Red channels in that order.
the depth buffer of the ImageViewport and ImageRender object. * "RGB1" will return 4 bytes per pixel with the Red, Green, Blue channels in that order and the alpha channel forced to 255.
* A special mode "F" allows to return the image as an array of float. This mode should only be used to retrieve
the depth buffer of the class:`ImageViewport` and :class:`ImageRender` objects.
The default mode is "RGBA". The default mode is "RGBA".
:type mode: str
:type mode: string :return: An object representing the image as one dimensional array of bytes of size (pixel_size*width*height),
:rtype: :class:`~bgl.buffer`
:return: A object representing the image as one dimensional array of bytes of size (pixel_size*width*height),
line by line starting from the bottom of the image. The pixel size and format is determined by the mode line by line starting from the bottom of the image. The pixel size and format is determined by the mode
parameter. For mode 'F', the array is a one dimensional array of float of size (width*height). parameter. For mode 'F', the array is a one dimensional array of float of size (width*height).
:rtype: :class:`~bgl.Buffer`
.. function:: materialID(object,name) .. function:: materialID(object, name)
Returns a numeric value that can be used in :class:`Texture` to create a dynamic texture. Returns a numeric value that can be used in :class:`Texture` to create a dynamic texture.
The value corresponds to an internal material number that uses the texture identified The value corresponds to an internal material number that uses the texture identified
by name. name is a string representing a texture name with IM prefix if you want to by name. name is a string representing a texture name with ``IM`` prefix if you want to
identify the texture directly. This method works for basic tex face and for material, identify the texture directly. This method works for basic tex face and for material,
provided the material has a texture channel using that particular texture in first provided the material has a texture channel using that particular texture in first
position of the texture stack. name can also have MA prefix if you want to identify position of the texture stack. name can also have ``MA`` prefix if you want to identify
the texture by material. In that case the material must have a texture channel in first the texture by material. In that case the material must have a texture channel in first
position. position.
If the object has no material that matches name, it generates a runtime error. Use try/except to catch the exception. If the object has no material that matches name, it generates a runtime error. Use try/except to catch the exception.
Ex: bge.texture.materialID(obj, 'IMvideo.png') Ex: ``bge.texture.materialID(obj, 'IMvideo.png')``
:arg object: the game object that uses the texture you want to make dynamic :arg object: The game object that uses the texture you want to make dynamic.
:type object: game object :type object: :class:`~bge.types.KX_GameObject`
:arg name: name of the texture/material you want to make dynamic. :arg name: Name of the texture/material you want to make dynamic.
:type name: string :type name: str
:rtype: integer
:return: The internal material number.
:rtype: int
.. function:: setLogFile(filename) .. function:: setLogFile(filename)
Sets the name of a text file in which runtime error messages will be written, in addition to the printing Sets the name of a text file in which runtime error messages will be written, in addition to the printing
of the messages on the Python console. Only the runtime errors specific to the VideoTexture module of the messages on the Python console. Only the runtime errors specific to the VideoTexture module
are written in that file, ordinary runtime time errors are not written. are written in that file, ordinary runtime time errors are not written.
:arg filename: name of error log file :arg filename: Name of the error log file.
:type filename: string :type filename: str
:rtype: integer
:return: -1 if the parameter name is invalid (not of type string), else 0.
:rtype: int
*********
Constants
*********
FFmpeg video and image statuses
+++++++++++++++++++++++++++++++
.. data:: SOURCE_ERROR
:type: int
.. data:: SOURCE_EMPTY
:type: int
.. data:: SOURCE_READY
:type: int
.. data:: SOURCE_PLAYING
:type: int
.. data:: SOURCE_STOPPED
:type: int
Image blending modes
++++++++++++++++++++
See Wikipedia's `Blend Modes <https://en.wikipedia.org/wiki/Blend_modes>`_ for reference.
.. data:: IMB_BLEND_MIX
:type: int
.. data:: IMB_BLEND_ADD
:type: int
.. data:: IMB_BLEND_SUB
:type: int
.. data:: IMB_BLEND_MUL
:type: int
.. data:: IMB_BLEND_LIGHTEN
:type: int
.. data:: IMB_BLEND_DARKEN
:type: int
.. data:: IMB_BLEND_ERASE_ALPHA
:type: int
.. data:: IMB_BLEND_ADD_ALPHA
:type: int
.. data:: IMB_BLEND_OVERLAY
:type: int
.. data:: IMB_BLEND_HARDLIGHT
:type: int
.. data:: IMB_BLEND_COLORBURN
:type: int
.. data:: IMB_BLEND_LINEARBURN
:type: int
.. data:: IMB_BLEND_COLORDODGE
:type: int
.. data:: IMB_BLEND_SCREEN
:type: int
.. data:: IMB_BLEND_SOFTLIGHT
:type: int
.. data:: IMB_BLEND_PINLIGHT
:type: int
.. data:: IMB_BLEND_VIVIDLIGHT
:type: int
.. data:: IMB_BLEND_LINEARLIGHT
:type: int
.. data:: IMB_BLEND_DIFFERENCE
:type: int
.. data:: IMB_BLEND_EXCLUSION
:type: int
.. data:: IMB_BLEND_HUE
:type: int
.. data:: IMB_BLEND_SATURATION
:type: int
.. data:: IMB_BLEND_LUMINOSITY
:type: int
.. data:: IMB_BLEND_COLOR
:type: int
.. data:: IMB_BLEND_COPY
:type: int
.. data:: IMB_BLEND_COPY_RGB
:type: int
.. data:: IMB_BLEND_COPY_ALPHA
:type: int